-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathclojure.set-api.html
More file actions
301 lines (264 loc) · 15.7 KB
/
Copy pathclojure.set-api.html
File metadata and controls
301 lines (264 loc) · 15.7 KB
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>clojure.set - Clojure v1.12.4 API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/wiki.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/internal.css" type="text/css" media="all" />
<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 href="index.html" id="Logo"><img src="static/clojure-icon.gif" width="100" height="100" alt="Clojure" /></a>
<h1><a href="index.html" id="page-header" title="page header title">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.12.4</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
</ul>
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
<li><a class="wiki_link" href="clojure.core-api.html">clojure.core</a></li><li><a class="wiki_link" href="clojure.data-api.html">clojure.data</a></li><li><a class="wiki_link" href="clojure.datafy-api.html">clojure.datafy</a></li><li><a class="wiki_link" href="clojure.edn-api.html">clojure.edn</a></li><li><a class="wiki_link" href="clojure.inspector-api.html">clojure.inspector</a></li><li><a class="wiki_link" href="clojure.instant-api.html">clojure.instant</a></li><li><a class="wiki_link" href="clojure.java.basis-api.html">clojure.java.basis</a></li><li><a class="wiki_link" href="clojure.java.browse-api.html">clojure.java.browse</a></li><li><a class="wiki_link" href="clojure.java.io-api.html">clojure.java.io</a></li><li><a class="wiki_link" href="clojure.java.javadoc-api.html">clojure.java.javadoc</a></li><li><a class="wiki_link" href="clojure.java.process-api.html">clojure.java.process</a></li><li><a class="wiki_link" href="clojure.java.shell-api.html">clojure.java.shell</a></li><li><a class="wiki_link" href="clojure.main-api.html">clojure.main</a></li><li><a class="wiki_link" href="clojure.math-api.html">clojure.math</a></li><li><a class="wiki_link" href="clojure.pprint-api.html">clojure.pprint</a></li><li><a class="wiki_link" href="clojure.reflect-api.html">clojure.reflect</a></li><li><a class="wiki_link" href="clojure.repl-api.html">clojure.repl</a></li><li><a class="wiki_link" href="clojure.set-api.html">clojure.set</a></li><li><a class="wiki_link" href="clojure.stacktrace-api.html">clojure.stacktrace</a></li><li><a class="wiki_link" href="clojure.string-api.html">clojure.string</a></li><li><a class="wiki_link" href="clojure.template-api.html">clojure.template</a></li><li><a class="wiki_link" href="clojure.test-api.html">clojure.test</a></li><li><a class="wiki_link" href="clojure.tools.deps.interop-api.html">clojure.tools.deps.interop</a></li><li><a class="wiki_link" href="clojure.walk-api.html">clojure.walk</a></li><li><a class="wiki_link" href="clojure.xml-api.html">clojure.xml</a></li><li><a class="wiki_link" href="clojure.zip-api.html">clojure.zip</a></li>
</ul>
</div>
<div class="BranchTOC">
<span class="toc-header">Other Versions</span>
<ul id="left-sidebar-branch-list">
<li><a class="wiki_link" href="index.html">v1.12.3 (stable)</a></li><li><a class="wiki_link" href="branch-master/index.html">v1.13 (in development)</a></li><li><a class="wiki_link" href="branch-clojure-1.11.4/index.html">v1.11.4 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.10.3/index.html">v1.10.3 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.9.0/index.html">v1.9 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.8.0/index.html">v1.8 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.7.0/index.html">v1.7 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.6.0/index.html">v1.6 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.5.0/index.html">v1.5 (legacy)</a></li><li><a class="wiki_link" href="branch-clojure-1.4.0/index.html">v1.4 (legacy)</a></li><li><a class="wiki_link" href="branch-1.3.x/index.html">v1.3 (legacy)</a></li><li><a class="wiki_link" href="branch-1.2.x/index.html">v1.2 (legacy)</a></li><li><a class="wiki_link" href="branch-1.1.x/index.html">v1.1 (legacy)</a></li>
</ul>
</div>
<a class="wiki_link" href="https://clojure.org">Clojure Home</a>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div class="wiki wikiPage" id="content_view">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#toc0">Overview</a>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#var-section">Vars and Functions</a>
<div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/difference" class="toc-entry-anchor">difference</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/index" class="toc-entry-anchor">index</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/intersection" class="toc-entry-anchor">intersection</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/join" class="toc-entry-anchor">join</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/map-invert" class="toc-entry-anchor">map-invert</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/project" class="toc-entry-anchor">project</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/rename" class="toc-entry-anchor">rename</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/rename-keys" class="toc-entry-anchor">rename-keys</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/select" class="toc-entry-anchor">select</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/subset?" class="toc-entry-anchor">subset?</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/superset?" class="toc-entry-anchor">superset?</a>
</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.set/union" class="toc-entry-anchor">union</a>
</div>
</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.set">clojure.set</span>
- <span id="header-project">Clojure</span> <span id="header-version">v1.12.4</span><span id="header-status-block"> (<span id="header-status">stable</span>)</span>
</h1>
<span id="author-line">by <span id="author-name">Rich Hickey</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.set</span>
<p></p>
<h2>Overview</h2>
<pre id="namespace-docstr">Set operations such as union/intersection.</pre>
<br />
<div id="var-section">
<p></p>
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/difference">difference</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (difference s1)
(difference s1 s2)
(difference s1 s2 & sets)
</pre>
<pre id="var-docstr">Return a set that is the first set without elements of the remaining sets</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L49">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/index">index</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (index xrel ks)
</pre>
<pre id="var-docstr">Returns a map of the distinct values of ks in the xrel mapped to a
set of the maps in xrel with the corresponding values of ks.</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L95">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/intersection">intersection</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (intersection s1)
(intersection s1 s2)
(intersection s1 s2 & sets)
</pre>
<pre id="var-docstr">Return a set that is the intersection of the input sets</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L33">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/join">join</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (join xrel yrel)
(join xrel yrel km)
</pre>
<pre id="var-docstr">When passed 2 rels, returns the rel corresponding to the natural
join. When passed an additional keymap, joins on the corresponding
keys.</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L115">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/map-invert">map-invert</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (map-invert m)
</pre>
<pre id="var-docstr">Returns the map with the vals mapped to the keys.</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L106">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/project">project</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (project xrel ks)
</pre>
<pre id="var-docstr">Returns a rel of the elements of xrel with only the keys in ks</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L72">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/rename">rename</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (rename xrel kmap)
</pre>
<pre id="var-docstr">Returns a rel of the maps in xrel with the keys in kmap renamed to the vals in kmap</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L89">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/rename-keys">rename-keys</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (rename-keys map kmap)
</pre>
<pre id="var-docstr">Returns the map with the keys in kmap renamed to the vals in kmap</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L78">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/select">select</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (select pred xset)
</pre>
<pre id="var-docstr">Returns a set of the elements for which pred is true</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L65">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/subset?">subset?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (subset? set1 set2)
</pre>
<pre id="var-docstr">Is set1 a subset of set2?</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.2</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L146">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/superset?">superset?</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (superset? set1 set2)
</pre>
<pre id="var-docstr">Is set1 a superset of set2?</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.2</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L154">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.set/union">union</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (union)
(union s1)
(union s1 s2)
(union s1 s2 & sets)
</pre>
<pre id="var-docstr">Return a set that is the union of the input sets</pre>
<pre id="var-specs"></pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a id="var-source" href="https://github.com/clojure/clojure/blob/631c46ed98ed3bfefdb8a15080e004ab470b0bf4/src/clj/clojure/set.clj#L20">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2025 by Rich Hickey</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>