• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1## sets.make
2
3<pre>
4sets.make(<a href="#sets.make-elements">elements</a>)
5</pre>
6
7Creates a new set.
8
9All elements must be hashable.
10
11
12### Parameters
13
14<table class="params-table">
15  <colgroup>
16    <col class="col-param" />
17    <col class="col-description" />
18  </colgroup>
19  <tbody>
20    <tr id="sets.make-elements">
21      <td><code>elements</code></td>
22      <td>
23        optional. default is <code>None</code>
24        <p>
25          Optional sequence to construct the set out of.
26        </p>
27      </td>
28    </tr>
29  </tbody>
30</table>
31
32
33## sets.copy
34
35<pre>
36sets.copy(<a href="#sets.copy-s">s</a>)
37</pre>
38
39Creates a new set from another set.
40
41### Parameters
42
43<table class="params-table">
44  <colgroup>
45    <col class="col-param" />
46    <col class="col-description" />
47  </colgroup>
48  <tbody>
49    <tr id="sets.copy-s">
50      <td><code>s</code></td>
51      <td>
52        required.
53        <p>
54          A set, as returned by `sets.make()`.
55        </p>
56      </td>
57    </tr>
58  </tbody>
59</table>
60
61
62## sets.to_list
63
64<pre>
65sets.to_list(<a href="#sets.to_list-s">s</a>)
66</pre>
67
68Creates a list from the values in the set.
69
70### Parameters
71
72<table class="params-table">
73  <colgroup>
74    <col class="col-param" />
75    <col class="col-description" />
76  </colgroup>
77  <tbody>
78    <tr id="sets.to_list-s">
79      <td><code>s</code></td>
80      <td>
81        required.
82        <p>
83          A set, as returned by `sets.make()`.
84        </p>
85      </td>
86    </tr>
87  </tbody>
88</table>
89
90
91## sets.insert
92
93<pre>
94sets.insert(<a href="#sets.insert-s">s</a>, <a href="#sets.insert-e">e</a>)
95</pre>
96
97Inserts an element into the set.
98
99Element must be hashable.  This mutates the original set.
100
101
102### Parameters
103
104<table class="params-table">
105  <colgroup>
106    <col class="col-param" />
107    <col class="col-description" />
108  </colgroup>
109  <tbody>
110    <tr id="sets.insert-s">
111      <td><code>s</code></td>
112      <td>
113        required.
114        <p>
115          A set, as returned by `sets.make()`.
116        </p>
117      </td>
118    </tr>
119    <tr id="sets.insert-e">
120      <td><code>e</code></td>
121      <td>
122        required.
123        <p>
124          The element to be inserted.
125        </p>
126      </td>
127    </tr>
128  </tbody>
129</table>
130
131
132## sets.contains
133
134<pre>
135sets.contains(<a href="#sets.contains-a">a</a>, <a href="#sets.contains-e">e</a>)
136</pre>
137
138Checks for the existence of an element in a set.
139
140### Parameters
141
142<table class="params-table">
143  <colgroup>
144    <col class="col-param" />
145    <col class="col-description" />
146  </colgroup>
147  <tbody>
148    <tr id="sets.contains-a">
149      <td><code>a</code></td>
150      <td>
151        required.
152        <p>
153          A set, as returned by `sets.make()`.
154        </p>
155      </td>
156    </tr>
157    <tr id="sets.contains-e">
158      <td><code>e</code></td>
159      <td>
160        required.
161        <p>
162          The element to look for.
163        </p>
164      </td>
165    </tr>
166  </tbody>
167</table>
168
169
170## sets.is_equal
171
172<pre>
173sets.is_equal(<a href="#sets.is_equal-a">a</a>, <a href="#sets.is_equal-b">b</a>)
174</pre>
175
176Returns whether two sets are equal.
177
178### Parameters
179
180<table class="params-table">
181  <colgroup>
182    <col class="col-param" />
183    <col class="col-description" />
184  </colgroup>
185  <tbody>
186    <tr id="sets.is_equal-a">
187      <td><code>a</code></td>
188      <td>
189        required.
190        <p>
191          A set, as returned by `sets.make()`.
192        </p>
193      </td>
194    </tr>
195    <tr id="sets.is_equal-b">
196      <td><code>b</code></td>
197      <td>
198        required.
199        <p>
200          A set, as returned by `sets.make()`.
201        </p>
202      </td>
203    </tr>
204  </tbody>
205</table>
206
207
208## sets.is_subset
209
210<pre>
211sets.is_subset(<a href="#sets.is_subset-a">a</a>, <a href="#sets.is_subset-b">b</a>)
212</pre>
213
214Returns whether `a` is a subset of `b`.
215
216### Parameters
217
218<table class="params-table">
219  <colgroup>
220    <col class="col-param" />
221    <col class="col-description" />
222  </colgroup>
223  <tbody>
224    <tr id="sets.is_subset-a">
225      <td><code>a</code></td>
226      <td>
227        required.
228        <p>
229          A set, as returned by `sets.make()`.
230        </p>
231      </td>
232    </tr>
233    <tr id="sets.is_subset-b">
234      <td><code>b</code></td>
235      <td>
236        required.
237        <p>
238          A set, as returned by `sets.make()`.
239        </p>
240      </td>
241    </tr>
242  </tbody>
243</table>
244
245
246## sets.disjoint
247
248<pre>
249sets.disjoint(<a href="#sets.disjoint-a">a</a>, <a href="#sets.disjoint-b">b</a>)
250</pre>
251
252Returns whether two sets are disjoint.
253
254Two sets are disjoint if they have no elements in common.
255
256
257### Parameters
258
259<table class="params-table">
260  <colgroup>
261    <col class="col-param" />
262    <col class="col-description" />
263  </colgroup>
264  <tbody>
265    <tr id="sets.disjoint-a">
266      <td><code>a</code></td>
267      <td>
268        required.
269        <p>
270          A set, as returned by `sets.make()`.
271        </p>
272      </td>
273    </tr>
274    <tr id="sets.disjoint-b">
275      <td><code>b</code></td>
276      <td>
277        required.
278        <p>
279          A set, as returned by `sets.make()`.
280        </p>
281      </td>
282    </tr>
283  </tbody>
284</table>
285
286
287## sets.intersection
288
289<pre>
290sets.intersection(<a href="#sets.intersection-a">a</a>, <a href="#sets.intersection-b">b</a>)
291</pre>
292
293Returns the intersection of two sets.
294
295### Parameters
296
297<table class="params-table">
298  <colgroup>
299    <col class="col-param" />
300    <col class="col-description" />
301  </colgroup>
302  <tbody>
303    <tr id="sets.intersection-a">
304      <td><code>a</code></td>
305      <td>
306        required.
307        <p>
308          A set, as returned by `sets.make()`.
309        </p>
310      </td>
311    </tr>
312    <tr id="sets.intersection-b">
313      <td><code>b</code></td>
314      <td>
315        required.
316        <p>
317          A set, as returned by `sets.make()`.
318        </p>
319      </td>
320    </tr>
321  </tbody>
322</table>
323
324
325## sets.union
326
327<pre>
328sets.union(<a href="#sets.union-args">args</a>)
329</pre>
330
331Returns the union of several sets.
332
333### Parameters
334
335<table class="params-table">
336  <colgroup>
337    <col class="col-param" />
338    <col class="col-description" />
339  </colgroup>
340  <tbody>
341    <tr id="sets.union-args">
342      <td><code>args</code></td>
343      <td>
344        optional.
345        <p>
346          An arbitrary number of sets or lists.
347        </p>
348      </td>
349    </tr>
350  </tbody>
351</table>
352
353
354## sets.difference
355
356<pre>
357sets.difference(<a href="#sets.difference-a">a</a>, <a href="#sets.difference-b">b</a>)
358</pre>
359
360Returns the elements in `a` that are not in `b`.
361
362### Parameters
363
364<table class="params-table">
365  <colgroup>
366    <col class="col-param" />
367    <col class="col-description" />
368  </colgroup>
369  <tbody>
370    <tr id="sets.difference-a">
371      <td><code>a</code></td>
372      <td>
373        required.
374        <p>
375          A set, as returned by `sets.make()`.
376        </p>
377      </td>
378    </tr>
379    <tr id="sets.difference-b">
380      <td><code>b</code></td>
381      <td>
382        required.
383        <p>
384          A set, as returned by `sets.make()`.
385        </p>
386      </td>
387    </tr>
388  </tbody>
389</table>
390
391
392## sets.length
393
394<pre>
395sets.length(<a href="#sets.length-s">s</a>)
396</pre>
397
398Returns the number of elements in a set.
399
400### Parameters
401
402<table class="params-table">
403  <colgroup>
404    <col class="col-param" />
405    <col class="col-description" />
406  </colgroup>
407  <tbody>
408    <tr id="sets.length-s">
409      <td><code>s</code></td>
410      <td>
411        required.
412        <p>
413          A set, as returned by `sets.make()`.
414        </p>
415      </td>
416    </tr>
417  </tbody>
418</table>
419
420
421## sets.remove
422
423<pre>
424sets.remove(<a href="#sets.remove-s">s</a>, <a href="#sets.remove-e">e</a>)
425</pre>
426
427Removes an element from the set.
428
429Element must be hashable.  This mutates the original set.
430
431
432### Parameters
433
434<table class="params-table">
435  <colgroup>
436    <col class="col-param" />
437    <col class="col-description" />
438  </colgroup>
439  <tbody>
440    <tr id="sets.remove-s">
441      <td><code>s</code></td>
442      <td>
443        required.
444        <p>
445          A set, as returned by `sets.make()`.
446        </p>
447      </td>
448    </tr>
449    <tr id="sets.remove-e">
450      <td><code>e</code></td>
451      <td>
452        required.
453        <p>
454          The element to be removed.
455        </p>
456      </td>
457    </tr>
458  </tbody>
459</table>
460
461
462## sets.repr
463
464<pre>
465sets.repr(<a href="#sets.repr-s">s</a>)
466</pre>
467
468Returns a string value representing the set.
469
470### Parameters
471
472<table class="params-table">
473  <colgroup>
474    <col class="col-param" />
475    <col class="col-description" />
476  </colgroup>
477  <tbody>
478    <tr id="sets.repr-s">
479      <td><code>s</code></td>
480      <td>
481        required.
482        <p>
483          A set, as returned by `sets.make()`.
484        </p>
485      </td>
486    </tr>
487  </tbody>
488</table>
489
490
491## sets.str
492
493<pre>
494sets.str(<a href="#sets.str-s">s</a>)
495</pre>
496
497Returns a string value representing the set.
498
499### Parameters
500
501<table class="params-table">
502  <colgroup>
503    <col class="col-param" />
504    <col class="col-description" />
505  </colgroup>
506  <tbody>
507    <tr id="sets.str-s">
508      <td><code>s</code></td>
509      <td>
510        required.
511        <p>
512          A set, as returned by `sets.make()`.
513        </p>
514      </td>
515    </tr>
516  </tbody>
517</table>
518
519
520