/
clojure.data-api.html
187 lines (168 loc) · 9.29 KB
/
clojure.data-api.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
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>clojure.data - Clojure v1.5 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" />
<style>.menuWrapper{height: 36px;}</style>
</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 Core 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</span> <span id="version">v1.5</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>
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
<li><a href="clojure.core-api.html" class="wiki_link">clojure.core</a></li><li><a href="clojure.data-api.html" class="wiki_link">clojure.data</a></li><li><a href="clojure.inspector-api.html" class="wiki_link">clojure.inspector</a></li><li><a href="clojure.java.browse-api.html" class="wiki_link">clojure.java.browse</a></li><li><a href="clojure.java.io-api.html" class="wiki_link">clojure.java.io</a></li><li><a href="clojure.java.javadoc-api.html" class="wiki_link">clojure.java.javadoc</a></li><li><a href="clojure.java.shell-api.html" class="wiki_link">clojure.java.shell</a></li><li><a href="clojure.main-api.html" class="wiki_link">clojure.main</a></li><li><a href="clojure.pprint-api.html" class="wiki_link">clojure.pprint</a></li><li><a href="clojure.reflect-api.html" class="wiki_link">clojure.reflect</a></li><li><a href="clojure.repl-api.html" class="wiki_link">clojure.repl</a></li><li><a href="clojure.set-api.html" class="wiki_link">clojure.set</a></li><li><a href="clojure.stacktrace-api.html" class="wiki_link">clojure.stacktrace</a></li><li><a href="clojure.string-api.html" class="wiki_link">clojure.string</a></li><li><a href="clojure.template-api.html" class="wiki_link">clojure.template</a></li><li><a href="clojure.test-api.html" class="wiki_link">clojure.test</a></li><li><a href="clojure.walk-api.html" class="wiki_link">clojure.walk</a></li><li><a href="clojure.xml-api.html" class="wiki_link">clojure.xml</a></li><li><a href="clojure.zip-api.html" class="wiki_link">clojure.zip</a></li>
</ul>
</div>
<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.4 (stable)</a></li><li><a href="../branch-1.3.x/index.html" class="wiki_link">v1.3 (stable)</a></li><li><a href="../branch-1.2.x/index.html" class="wiki_link">v1.2 (legacy)</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">v1.1 (legacy)</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" style="margin-top: 3px;">Overview</a>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#proto-section" style="margin-top: 3px;">Protocols</a>
<div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.data/Diff">Diff</a>
<div style="margin-left: 1em;" class="toc-subentry">
<a class="toc-subentry-anchor" href="#clojure.data/diff-similar">diff-similar</a>
</div>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.data/EqualityPartition">EqualityPartition</a>
<div style="margin-left: 1em;" class="toc-subentry">
<a class="toc-subentry-anchor" href="#clojure.data/equality-partition">equality-partition</a>
</div>
</div>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#" style="margin-top: 3px;"></a>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#var-section" style="margin-top: 3px;">Vars and Functions</a>
<div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.data/diff">diff</a>
</div>
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.data">clojure.data</span>
- <span id="header-project">Clojure</span> <span id="header-version">v1.5</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
</h1>
<span id="author-line">by <span id="author-name">Stuart Halloway</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.data</span>
<p></p>
<h2>Overview</h2>
<pre id="namespace-docstr">Non-core data functions.</pre>
<br />
<div id="proto-section">
<p></p>
<h2>Protocols</h2>
<div id="proto-entry">
<br />
<hr />
<h2 id="clojure.data/Diff">Diff</h2>
<span id="proto-type">Protocol</span><br />
<pre id="proto-docstr">Implementation detail. Subject to change.</pre>
Known implementations: <span id="proto-impls">java.util.List, java.util.Map, java.util.Set, nil, Object</span>
<div id="proto-var-entry">
<br />
<h3 id="clojure.data/diff-similar">diff-similar</h3>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (diff-similar a b)
</pre>
<pre id="var-docstr">Implementation detail. Subject to change.</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
</div>
<span class="proto-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/9baebd091b1301aecaaac3b5f9c7ede5dcc58f8c/src/clj/clojure/data.clj#L71" id="proto-source">Source</a>
</div><div id="proto-entry">
<br />
<hr />
<h2 id="clojure.data/EqualityPartition">EqualityPartition</h2>
<span id="proto-type">Protocol</span><br />
<pre id="proto-docstr">Implementation detail. Subject to change.</pre>
Known implementations: <span id="proto-impls">java.util.List, java.util.Map, java.util.Set, nil, Object</span>
<div id="proto-var-entry">
<br />
<h3 id="clojure.data/equality-partition">equality-partition</h3>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (equality-partition x)
</pre>
<pre id="var-docstr">Implementation detail. Subject to change.</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
</div>
<span class="proto-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/9baebd091b1301aecaaac3b5f9c7ede5dcc58f8c/src/clj/clojure/data.clj#L67" id="proto-source">Source</a>
</div>
</div>
<div id="var-section">
<p></p>
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.data/diff">diff</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (diff a b)
</pre>
<pre id="var-docstr">Recursively compares a and b, returning a tuple of
[things-only-in-a things-only-in-b things-in-both].
Comparison rules:
* For equal a and b, return [nil nil a].
* Maps are subdiffed where keys match and values differ.
* Sets are never subdiffed.
* All sequential things are treated as associative collections
by their indexes, with results returned as vectors.
* Everything else (including strings!) is treated as
an atom and compared for equality.</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/9baebd091b1301aecaaac3b5f9c7ede5dcc58f8c/src/clj/clojure/data.clj#L120" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2012 by Rich Hickey</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>