Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
Nim
/
sets.html

sets.html 160 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>std/sets</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">std/sets</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    56. 

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

  59.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    60. 

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#HashSet" title="HashSet[A] {..} = object">HashSet</a></li>
    62. 

  62. <li><a class="reference" href="#OrderedSet" title="OrderedSet[A] {..} = object">OrderedSet</a></li>
    63. 

  63. <li><a class="reference" href="#SomeSet" title="SomeSet[A] = HashSet[A] | OrderedSet[A]">SomeSet</a></li>
    64. 

  64. 

  65.     </ul>
    66. 

  66.   </details>
    67. 

  67. </li>
    68. 

  68. <li>
    69. 

  69.   <details open>
    70. 

  70.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    71. 

  71.     <ul class="simple simple-toc-section">
    72. 

  72.       <li><a class="reference" href="#defaultInitialSize" title="defaultInitialSize = 64">defaultInitialSize</a></li>
    73. 

  73. 

  74.     </ul>
    75. 

  75.   </details>
    76. 

  76. </li>
    77. 

  77. <li>
    78. 

  78.   <details open>
    79. 

  79.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    80. 

  80.     <ul class="simple simple-toc-section">
    81. 

  81.       <ul class="simple nested-toc-section">$
    82. 

  82.   <li><a class="reference" href="#%24%2CHashSet%5BA%5D" title="`$`[A](s: HashSet[A]): string">`$`[A](s: HashSet[A]): string</a></li>
    83. 

  83. <li><a class="reference" href="#%24%2COrderedSet%5BA%5D" title="`$`[A](s: OrderedSet[A]): string">`$`[A](s: OrderedSet[A]): string</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">*
    87. 

  87.   <li><a class="reference" href="#%2A%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`*`[A](s1, s2: HashSet[A]): HashSet[A]">`*`[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">+
    91. 

  91.   <li><a class="reference" href="#%2B%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`+`[A](s1, s2: HashSet[A]): HashSet[A]">`+`[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">-
    95. 

  95.   <li><a class="reference" href="#-%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`-`[A](s1, s2: HashSet[A]): HashSet[A]">`-`[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    96. 

  96. 

  97. </ul>
    98. 

  98. <ul class="simple nested-toc-section">-+-
    99. 

  99.   <li><a class="reference" href="#-%2B-%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`-+-`[A](s1, s2: HashSet[A]): HashSet[A]">`-+-`[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    100. 

  100. 

  101. </ul>
    102. 

  102. <ul class="simple nested-toc-section"><
    103. 

  103.   <li><a class="reference" href="#%3C%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`&lt;`[A](s, t: HashSet[A]): bool">`&lt;`[A](s, t: HashSet[A]): bool</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section"><=
    107. 

  107.   <li><a class="reference" href="#%3C%3D%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`&lt;=`[A](s, t: HashSet[A]): bool">`&lt;=`[A](s, t: HashSet[A]): bool</a></li>
    108. 

  108. 

  109. </ul>
    110. 

  110. <ul class="simple nested-toc-section">==
    111. 

  111.   <li><a class="reference" href="#%3D%3D%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="`==`[A](s, t: HashSet[A]): bool">`==`[A](s, t: HashSet[A]): bool</a></li>
    112. 

  112. <li><a class="reference" href="#%3D%3D%2COrderedSet%5BA%5D%2COrderedSet%5BA%5D" title="`==`[A](s, t: OrderedSet[A]): bool">`==`[A](s, t: OrderedSet[A]): bool</a></li>
    113. 

  113. 

  114. </ul>
    115. 

  115. <ul class="simple nested-toc-section">[]
    116. 

  116.   <li><a class="reference" href="#%5B%5D%2CHashSet%5BA%5D%2CA" title="`[]`[A](s: var HashSet[A]; key: A): var A">`[]`[A](s: var HashSet[A]; key: A): var A</a></li>
    117. 

  117. 

  118. </ul>
    119. 

  119. <ul class="simple nested-toc-section">card
    120. 

  120.   <li><a class="reference" href="#card%2CHashSet%5BA%5D" title="card[A](s: HashSet[A]): int">card[A](s: HashSet[A]): int</a></li>
    121. 

  121. <li><a class="reference" href="#card%2COrderedSet%5BA%5D" title="card[A](s: OrderedSet[A]): int">card[A](s: OrderedSet[A]): int</a></li>
    122. 

  122. 

  123. </ul>
    124. 

  124. <ul class="simple nested-toc-section">clear
    125. 

  125.   <li><a class="reference" href="#clear%2CHashSet%5BA%5D" title="clear[A](s: var HashSet[A])">clear[A](s: var HashSet[A])</a></li>
    126. 

  126. <li><a class="reference" href="#clear%2COrderedSet%5BA%5D" title="clear[A](s: var OrderedSet[A])">clear[A](s: var OrderedSet[A])</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">contains
    130. 

  130.   <li><a class="reference" href="#contains%2CHashSet%5BA%5D%2CA" title="contains[A](s: HashSet[A]; key: A): bool">contains[A](s: HashSet[A]; key: A): bool</a></li>
    131. 

  131. <li><a class="reference" href="#contains%2COrderedSet%5BA%5D%2CA" title="contains[A](s: OrderedSet[A]; key: A): bool">contains[A](s: OrderedSet[A]; key: A): bool</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">containsOrIncl
    135. 

  135.   <li><a class="reference" href="#containsOrIncl%2CHashSet%5BA%5D%2CA" title="containsOrIncl[A](s: var HashSet[A]; key: A): bool">containsOrIncl[A](s: var HashSet[A]; key: A): bool</a></li>
    136. 

  136. <li><a class="reference" href="#containsOrIncl%2COrderedSet%5BA%5D%2CA" title="containsOrIncl[A](s: var OrderedSet[A]; key: A): bool">containsOrIncl[A](s: var OrderedSet[A]; key: A): bool</a></li>
    137. 

  137. 

  138. </ul>
    139. 

  139. <ul class="simple nested-toc-section">difference
    140. 

  140.   <li><a class="reference" href="#difference%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="difference[A](s1, s2: HashSet[A]): HashSet[A]">difference[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    141. 

  141. 

  142. </ul>
    143. 

  143. <ul class="simple nested-toc-section">disjoint
    144. 

  144.   <li><a class="reference" href="#disjoint%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="disjoint[A](s1, s2: HashSet[A]): bool">disjoint[A](s1, s2: HashSet[A]): bool</a></li>
    145. 

  145. 

  146. </ul>
    147. 

  147. <ul class="simple nested-toc-section">excl
    148. 

  148.   <li><a class="reference" href="#excl%2CHashSet%5BA%5D%2CA" title="excl[A](s: var HashSet[A]; key: A)">excl[A](s: var HashSet[A]; key: A)</a></li>
    149. 

  149. <li><a class="reference" href="#excl%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="excl[A](s: var HashSet[A]; other: HashSet[A])">excl[A](s: var HashSet[A]; other: HashSet[A])</a></li>
    150. 

  150. <li><a class="reference" href="#excl%2COrderedSet%5BA%5D%2CA" title="excl[A](s: var OrderedSet[A]; key: A)">excl[A](s: var OrderedSet[A]; key: A)</a></li>
    151. 

  151. 

  152. </ul>
    153. 

  153. <ul class="simple nested-toc-section">hash
    154. 

  154.   <li><a class="reference" href="#hash%2CHashSet%5BA%5D" title="hash[A](s: HashSet[A]): Hash">hash[A](s: HashSet[A]): Hash</a></li>
    155. 

  155. <li><a class="reference" href="#hash%2COrderedSet%5BA%5D" title="hash[A](s: OrderedSet[A]): Hash">hash[A](s: OrderedSet[A]): Hash</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">incl
    159. 

  159.   <li><a class="reference" href="#incl%2CHashSet%5BA%5D%2CA" title="incl[A](s: var HashSet[A]; key: A)">incl[A](s: var HashSet[A]; key: A)</a></li>
    160. 

  160. <li><a class="reference" href="#incl%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="incl[A](s: var HashSet[A]; other: HashSet[A])">incl[A](s: var HashSet[A]; other: HashSet[A])</a></li>
    161. 

  161. <li><a class="reference" href="#incl%2CHashSet%5BA%5D%2COrderedSet%5BA%5D" title="incl[A](s: var HashSet[A]; other: OrderedSet[A])">incl[A](s: var HashSet[A]; other: OrderedSet[A])</a></li>
    162. 

  162. <li><a class="reference" href="#incl%2COrderedSet%5BA%5D%2CA" title="incl[A](s: var OrderedSet[A]; key: A)">incl[A](s: var OrderedSet[A]; key: A)</a></li>
    163. 

  163. 

  164. </ul>
    165. 

  165. <ul class="simple nested-toc-section">init
    166. 

  166.   <li><a class="reference" href="#init%2CHashSet%5BA%5D" title="init[A](s: var HashSet[A]; initialSize = defaultInitialSize)">init[A](s: var HashSet[A]; initialSize = defaultInitialSize)</a></li>
    167. 

  167. <li><a class="reference" href="#init%2COrderedSet%5BA%5D" title="init[A](s: var OrderedSet[A]; initialSize = defaultInitialSize)">init[A](s: var OrderedSet[A]; initialSize = defaultInitialSize)</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">initHashSet
    171. 

  171.   <li><a class="reference" href="#initHashSet" title="initHashSet[A](initialSize = defaultInitialSize): HashSet[A]">initHashSet[A](initialSize = defaultInitialSize): HashSet[A]</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">initOrderedSet
    175. 

  175.   <li><a class="reference" href="#initOrderedSet" title="initOrderedSet[A](initialSize = defaultInitialSize): OrderedSet[A]">initOrderedSet[A](initialSize = defaultInitialSize): OrderedSet[A]</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">initSet
    179. 

  179.   <li><a class="reference" href="#initSet" title="initSet[A](initialSize = defaultInitialSize): HashSet[A]">initSet[A](initialSize = defaultInitialSize): HashSet[A]</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">intersection
    183. 

  183.   <li><a class="reference" href="#intersection%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="intersection[A](s1, s2: HashSet[A]): HashSet[A]">intersection[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">isValid
    187. 

  187.   <li><a class="reference" href="#isValid%2CHashSet%5BA%5D" title="isValid[A](s: HashSet[A]): bool">isValid[A](s: HashSet[A]): bool</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">len
    191. 

  191.   <li><a class="reference" href="#len%2CHashSet%5BA%5D" title="len[A](s: HashSet[A]): int">len[A](s: HashSet[A]): int</a></li>
    192. 

  192. <li><a class="reference" href="#len%2COrderedSet%5BA%5D" title="len[A](s: OrderedSet[A]): int">len[A](s: OrderedSet[A]): int</a></li>
    193. 

  193. 

  194. </ul>
    195. 

  195. <ul class="simple nested-toc-section">map
    196. 

  196.   <li><a class="reference" href="#map%2CHashSet%5BA%5D%2Cproc%28A%29" title="map[A, B](data: HashSet[A]; op: proc (x: A): B {.closure.}): HashSet[B]">map[A, B](data: HashSet[A]; op: proc (x: A): B {.closure.}): HashSet[B]</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">missingOrExcl
    200. 

  200.   <li><a class="reference" href="#missingOrExcl%2CHashSet%5BA%5D%2CA" title="missingOrExcl[A](s: var HashSet[A]; key: A): bool">missingOrExcl[A](s: var HashSet[A]; key: A): bool</a></li>
    201. 

  201. <li><a class="reference" href="#missingOrExcl%2COrderedSet%5BA%5D%2CA" title="missingOrExcl[A](s: var OrderedSet[A]; key: A): bool">missingOrExcl[A](s: var OrderedSet[A]; key: A): bool</a></li>
    202. 

  202. 

  203. </ul>
    204. 

  204. <ul class="simple nested-toc-section">pop
    205. 

  205.   <li><a class="reference" href="#pop%2CHashSet%5BA%5D" title="pop[A](s: var HashSet[A]): A">pop[A](s: var HashSet[A]): A</a></li>
    206. 

  206. 

  207. </ul>
    208. 

  208. <ul class="simple nested-toc-section">symmetricDifference
    209. 

  209.   <li><a class="reference" href="#symmetricDifference%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="symmetricDifference[A](s1, s2: HashSet[A]): HashSet[A]">symmetricDifference[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    210. 

  210. 

  211. </ul>
    212. 

  212. <ul class="simple nested-toc-section">toHashSet
    213. 

  213.   <li><a class="reference" href="#toHashSet%2CopenArray%5BA%5D" title="toHashSet[A](keys: openArray[A]): HashSet[A]">toHashSet[A](keys: openArray[A]): HashSet[A]</a></li>
    214. 

  214. 

  215. </ul>
    216. 

  216. <ul class="simple nested-toc-section">toOrderedSet
    217. 

  217.   <li><a class="reference" href="#toOrderedSet%2CopenArray%5BA%5D" title="toOrderedSet[A](keys: openArray[A]): OrderedSet[A]">toOrderedSet[A](keys: openArray[A]): OrderedSet[A]</a></li>
    218. 

  218. 

  219. </ul>
    220. 

  220. <ul class="simple nested-toc-section">toSet
    221. 

  221.   <li><a class="reference" href="#toSet%2CopenArray%5BA%5D" title="toSet[A](keys: openArray[A]): HashSet[A]">toSet[A](keys: openArray[A]): HashSet[A]</a></li>
    222. 

  222. 

  223. </ul>
    224. 

  224. <ul class="simple nested-toc-section">union
    225. 

  225.   <li><a class="reference" href="#union%2CHashSet%5BA%5D%2CHashSet%5BA%5D" title="union[A](s1, s2: HashSet[A]): HashSet[A]">union[A](s1, s2: HashSet[A]): HashSet[A]</a></li>
    226. 

  226. 

  227. </ul>
    228. 

  228. 

  229.     </ul>
    230. 

  230.   </details>
    231. 

  231. </li>
    232. 

  232. <li>
    233. 

  233.   <details open>
    234. 

  234.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    235. 

  235.     <ul class="simple simple-toc-section">
    236. 

  236.       <ul class="simple nested-toc-section">items
    237. 

  237.   <li><a class="reference" href="#items.i%2CHashSet%5BA%5D" title="items[A](s: HashSet[A]): A">items[A](s: HashSet[A]): A</a></li>
    238. 

  238. <li><a class="reference" href="#items.i%2COrderedSet%5BA%5D" title="items[A](s: OrderedSet[A]): A">items[A](s: OrderedSet[A]): A</a></li>
    239. 

  239. 

  240. </ul>
    241. 

  241. <ul class="simple nested-toc-section">pairs
    242. 

  242.   <li><a class="reference" href="#pairs.i%2COrderedSet%5BA%5D" title="pairs[A](s: OrderedSet[A]): tuple[a: int, b: A]">pairs[A](s: OrderedSet[A]): tuple[a: int, b: A]</a></li>
    243. 

  243. 

  244. </ul>
    245. 

  245. 

  246.     </ul>
    247. 

  247.   </details>
    248. 

  248. </li>
    249. 

  249. 

  250. </ul>
    251. 

  251. 

  252.   </div>
    253. 

  253.   <div class="nine columns" id="content">
    254. 

  254.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    255. 

  255. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    256. 

  256. 

  257.     <div id="tocRoot"></div>
    258. 

  258.     
    259. 

  259.     <p class="module-desc"><p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">sets</span></span></tt> module implements an efficient <span id="hash-set_1">hash set</span> and ordered hash set.</p>
    260. 

  260. <p>Hash sets are different from the <a class="reference external" href="manual.html#types-set-type">built in set type</a>. Sets allow you to store any value that can be <a class="reference external" href="hashes.html">hashed</a> and they don't contain duplicate entries.</p>
    261. 

  261. <p>Common usages of sets:</p>
    262. 

  262. <ul class="simple"><li>removing duplicates from a container by converting it with <a class="reference external" href="#toHashSet,openArray[A]">toHashSet proc</a> (see also <a class="reference external" href="sequtils.html#deduplicate,openArray[T],bool">sequtils.deduplicate func</a>)</li>
    263. 

  263. <li>membership testing</li>
    264. 

  264. <li>mathematical operations on two sets, such as <a class="reference external" href="#union,HashSet[A],HashSet[A]">union</a>, <a class="reference external" href="#intersection,HashSet[A],HashSet[A]">intersection</a>, <a class="reference external" href="#difference,HashSet[A],HashSet[A]">difference</a>, and <a class="reference external" href="#symmetricDifference,HashSet[A],HashSet[A]">symmetric difference</a></li>
    265. 

  265. </ul>
    266. 

  266. <p><strong>Examples:</strong></p>
    267. 

  267. <p><pre class="listing"><span class="Identifier">echo</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>     <span class="Comment"># {9, 1, 5}</span>
    268. 

  268. <span class="Identifier">echo</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>  <span class="Comment"># {9, 5, 1}</span>
    269. 

  269. 

  270. <span class="Keyword">let</span>
    271. 

  271.   <span class="Identifier">s1</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    272. 

  272.   <span class="Identifier">s2</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    273. 

  273. 

  274. <span class="Identifier">echo</span> <span class="Identifier">s1</span> <span class="Operator">+</span> <span class="Identifier">s2</span>    <span class="Comment"># {9, 1, 3, 5, 7}</span>
    275. 

  275. <span class="Identifier">echo</span> <span class="Identifier">s1</span> <span class="Operator">-</span> <span class="Identifier">s2</span>    <span class="Comment"># {1, 9}</span>
    276. 

  276. <span class="Identifier">echo</span> <span class="Identifier">s1</span> <span class="Operator">*</span> <span class="Identifier">s2</span>    <span class="Comment"># {5}</span>
    277. 

  277. <span class="Identifier">echo</span> <span class="Identifier">s1</span> <span class="Operator">-+-</span> <span class="Identifier">s2</span>  <span class="Comment"># {9, 1, 3, 7}</span></pre></p>
    278. 

  278. <p>Note: The data types declared here have <em>value semantics</em>: This means that <tt class="docutils literal"><span class="pre"><span class="Operator">=</span></span></tt> performs a copy of the set.</p>
    279. 

  279. <p><strong>See also:</strong></p>
    280. 

  280. <ul class="simple"><li><a class="reference external" href="intsets.html">intsets module</a> for efficient int sets</li>
    281. 

  281. <li><a class="reference external" href="tables.html">tables module</a> for hash tables</li>
    282. 

  282. </ul>
    283. 

  283. </p>
    284. 

  284.     <div class="section" id="6">
    285. 

  285.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    286. 

  286.   <dl class="item">
    287. 

  287.     <a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="math.html">math</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="outparams.html">outparams</a>
    288. 

  288.   </dl>
    289. 

  289. </div>
    290. 

  290. <div class="section" id="7">
    291. 

  291.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    292. 

  292.   <dl class="item">
    293. 

  293.     <div id="HashSet">
    294. 

  294.   <dt><pre><a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {..} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    295. 

  295.   <dd>
    296. 

  296.     
    297. 

  297.     <p>
    298. 

  298. A generic hash set.</p>
    299. 

  299. <p>Use <a class="reference external" href="#init,HashSet[A]">init proc</a> or <a class="reference external" href="#initHashSet">initHashSet proc</a> before calling other procs on it.</p>
    300. 

  300. 

  301.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L66" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    302. 

  302. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L66" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    303. 

  303. 

  304.   </dd>
    305. 

  305. </div>
    306. 

  306. <div id="OrderedSet">
    307. 

  307.   <dt><pre><a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {..} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    308. 

  308.   <dd>
    309. 

  309.     
    310. 

  310.     <p>
    311. 

  311. A generic hash set that remembers insertion order.</p>
    312. 

  312. <p>Use <a class="reference external" href="#init,OrderedSet[A]">init proc</a> or <a class="reference external" href="#initOrderedSet">initOrderedSet proc</a> before calling other procs on it.</p>
    313. 

  313. 

  314.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L78" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    315. 

  315. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L78" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    316. 

  316. 

  317.   </dd>
    318. 

  318. </div>
    319. 

  319. <div id="SomeSet">
    320. 

  320.   <dt><pre><a href="sets.html#SomeSet"><span class="Identifier">SomeSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> <span class="Other">=</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> <span class="Operator">|</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    321. 

  321.   <dd>
    322. 

  322.     
    323. 

  323.     Type union representing <tt class="docutils literal"><span class="pre"><span class="Identifier">HashSet</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">OrderedSet</span></span></tt>.
    324. 

  324.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L85" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    325. 

  325. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L85" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    326. 

  326. 

  327.   </dd>
    328. 

  328. </div>
    329. 

  329. 

  330.   </dl>
    331. 

  331. </div>
    332. 

  332. <div class="section" id="10">
    333. 

  333.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    334. 

  334.   <dl class="item">
    335. 

  335.     <div id="defaultInitialSize">
    336. 

  336.   <dt><pre><a href="sets.html#defaultInitialSize"><span class="Identifier">defaultInitialSize</span></a> <span class="Other">=</span> <span class="DecNumber">64</span></pre></dt>
    337. 

  337.   <dd>
    338. 

  338.     
    339. 

  339.     
    340. 

  340.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L89" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    341. 

  341. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L89" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    342. 

  342. 

  343.   </dd>
    344. 

  344. </div>
    345. 

  345. 

  346.   </dl>
    347. 

  347. </div>
    348. 

  348. <div class="section" id="12">
    349. 

  349.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    350. 

  350.   <dl class="item">
    351. 

  351.     <div id="$-procs-all">
    352. 

  352.   <div id="$,HashSet[A]">
    353. 

  353.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CHashSet%5BA%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    354. 

  354.   <dd>
    355. 

  355.     
    356. 

  356.     <p>Converts the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to a string, mostly for logging and printing purposes.</p>
    357. 

  357. <p>Don't use this proc for serialization, the representation may change at any moment and values are not escaped.</p>
    358. 

  358. <p><strong>Examples:</strong></p>
    359. 

  359. <p><pre class="listing"><span class="Identifier">echo</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    360. 

  360. <span class="Comment"># --&gt; {2, 4, 5}</span>
    361. 

  361. <span class="Identifier">echo</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;no&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;esc'aping&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is </span><span class="EscapeSequence">\&quot;</span><span class="StringLit"> provided&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    362. 

  362. <span class="Comment"># --&gt; {no, esc'aping, is &quot; provided}</span></pre></p>
    363. 

  363. 

  364.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L587" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    365. 

  365. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L587" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    366. 

  366. 

  367.   </dd>
    368. 

  368. </div>
    369. 

  369. <div id="$,OrderedSet[A]">
    370. 

  370.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2COrderedSet%5BA%5D"><span class="Identifier">`$`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
    371. 

  371.   <dd>
    372. 

  372.     
    373. 

  373.     <p>Converts the ordered hash set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to a string, mostly for logging and printing purposes.</p>
    374. 

  374. <p>Don't use this proc for serialization, the representation may change at any moment and values are not escaped.</p>
    375. 

  375. <p><strong>Examples:</strong></p>
    376. 

  376. <p><pre class="listing"><span class="Identifier">echo</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    377. 

  377. <span class="Comment"># --&gt; {2, 4, 5}</span>
    378. 

  378. <span class="Identifier">echo</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;no&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;esc'aping&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;is </span><span class="EscapeSequence">\&quot;</span><span class="StringLit"> provided&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    379. 

  379. <span class="Comment"># --&gt; {no, esc'aping, is &quot; provided}</span></pre></p>
    380. 

  380. 

  381.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L876" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    382. 

  382. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L876" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    383. 

  383. 

  384.   </dd>
    385. 

  385. </div>
    386. 

  386. 

  387. </div>
    388. 

  388. <div id="*-procs-all">
    389. 

  389.   <div id="*,HashSet[A],HashSet[A]">
    390. 

  390.   <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    391. 

  391.   <dd>
    392. 

  392.     
    393. 

  393.     Alias for <a class="reference external" href="#intersection,HashSet[A],HashSet[A]">intersection(s1, s2)</a>.
    394. 

  394.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L495" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    395. 

  395. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L495" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    396. 

  396. 

  397.   </dd>
    398. 

  398. </div>
    399. 

  399. 

  400. </div>
    401. 

  401. <div id="+-procs-all">
    402. 

  402.   <div id="+,HashSet[A],HashSet[A]">
    403. 

  403.   <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    404. 

  404.   <dd>
    405. 

  405.     
    406. 

  406.     Alias for <a class="reference external" href="#union,HashSet[A],HashSet[A]">union(s1, s2)</a>.
    407. 

  407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L491" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    408. 

  408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L491" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    409. 

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. 

  413. </div>
    414. 

  414. <div id="--procs-all">
    415. 

  415.   <div id="-,HashSet[A],HashSet[A]">
    416. 

  416.   <dt><pre><span class="Keyword">proc</span> <a href="#-%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    417. 

  417.   <dd>
    418. 

  418.     
    419. 

  419.     Alias for <a class="reference external" href="#difference,HashSet[A],HashSet[A]">difference(s1, s2)</a>.
    420. 

  420.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L499" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    421. 

  421. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L499" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    422. 

  422. 

  423.   </dd>
    424. 

  424. </div>
    425. 

  425. 

  426. </div>
    427. 

  427. <div id="-+--procs-all">
    428. 

  428.   <div id="-+-,HashSet[A],HashSet[A]">
    429. 

  429.   <dt><pre><span class="Keyword">proc</span> <a href="#-%2B-%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`-+-`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
    430. 

  430.   <dd>
    431. 

  431.     
    432. 

  432.     Alias for <a class="reference external" href="#symmetricDifference,HashSet[A],HashSet[A]">symmetricDifference(s1, s2)</a>.
    433. 

  433.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L503" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    434. 

  434. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L503" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    435. 

  435. 

  436.   </dd>
    437. 

  437. </div>
    438. 

  438. 

  439. </div>
    440. 

  440. <div id="&lt;-procs-all">
    441. 

  441.   <div id="<,HashSet[A],HashSet[A]">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`&lt;`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">t</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    443. 

  443.   <dd>
    444. 

  444.     
    445. 

  445.     <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> is a strict or proper subset of <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>.</p>
    446. 

  446. <p>A strict or proper subset <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> has all of its members in <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> but <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> has more elements than <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    447. 

  447. 

  448. <p><strong class="examples_text">Example:</strong></p>
    449. 

  449. <pre class="listing"><span class="Keyword">let</span>
    450. 

  450.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    451. 

  451.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    452. 

  452.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">intersection</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    453. 

  453. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">&lt;</span> <span class="Identifier">a</span> <span class="Keyword">and</span> <span class="Identifier">c</span> <span class="Operator">&lt;</span> <span class="Identifier">b</span>
    454. 

  454. <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator">&lt;</span> <span class="Identifier">a</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
    455. 

  455.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L521" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    456. 

  456. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L521" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    457. 

  457. 

  458.   </dd>
    459. 

  459. </div>
    460. 

  460. 

  461. </div>
    462. 

  462. <div id="&lt;=-procs-all">
    463. 

  463.   <div id="<=,HashSet[A],HashSet[A]">
    464. 

  464.   <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`&lt;=`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">t</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    465. 

  465.   <dd>
    466. 

  466.     
    467. 

  467.     <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> is a subset of <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>.</p>
    468. 

  468. <p>A subset <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> has all of its members in <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> doesn't necessarily have more members than <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. That is, <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> can be equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt>.</p>
    469. 

  469. 

  470. <p><strong class="examples_text">Example:</strong></p>
    471. 

  471. <pre class="listing"><span class="Keyword">let</span>
    472. 

  472.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    473. 

  473.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    474. 

  474.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">intersection</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    475. 

  475. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">&lt;=</span> <span class="Identifier">a</span> <span class="Keyword">and</span> <span class="Identifier">c</span> <span class="Operator">&lt;=</span> <span class="Identifier">b</span>
    476. 

  476. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">&lt;=</span> <span class="Identifier">a</span></pre>
    477. 

  477.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L536" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    478. 

  478. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L536" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    479. 

  479. 

  480.   </dd>
    481. 

  481. </div>
    482. 

  482. 

  483. </div>
    484. 

  484. <div id="==-procs-all">
    485. 

  485.   <div id="==,HashSet[A],HashSet[A]">
    486. 

  486.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">t</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    487. 

  487.   <dd>
    488. 

  488.     
    489. 

  489.     Returns true if both <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">t</span></span></tt> have the same members and set size.
    490. 

  490. <p><strong class="examples_text">Example:</strong></p>
    491. 

  491. <pre class="listing"><span class="Keyword">var</span>
    492. 

  492.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    493. 

  493.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    494. 

  494. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">b</span></pre>
    495. 

  495.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L557" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    496. 

  496. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L557" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    497. 

  497. 

  498.   </dd>
    499. 

  499. </div>
    500. 

  500. <div id="==,OrderedSet[A],OrderedSet[A]">
    501. 

  501.   <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2COrderedSet%5BA%5D%2COrderedSet%5BA%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">,</span> <span class="Identifier">t</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    502. 

  502.   <dd>
    503. 

  503.     
    504. 

  504.     Equality for ordered sets.
    505. 

  505. <p><strong class="examples_text">Example:</strong></p>
    506. 

  506. <pre class="listing"><span class="Keyword">let</span>
    507. 

  507.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    508. 

  508.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    509. 

  509. <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">b</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
    510. 

  510.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L846" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    511. 

  511. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L846" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    512. 

  512. 

  513.   </dd>
    514. 

  514. </div>
    515. 

  515. 

  516. </div>
    517. 

  517. <div id="[]-procs-all">
    518. 

  518.   <div id="[],HashSet[A],A">
    519. 

  519.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CHashSet%5BA%5D%2CA"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">A</span></pre></dt>
    520. 

  520.   <dd>
    521. 

  521.     
    522. 

  522.     <p>Returns the element that is actually stored in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> which has the same value as <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> or raises the <tt class="docutils literal"><span class="pre"><span class="Identifier">KeyError</span></span></tt> exception.</p>
    523. 

  523. <p>This is useful when one overloaded <tt class="docutils literal"><span class="pre"><span class="Identifier">hash</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> but still needs reference semantics for sharing.</p>
    524. 

  524. 

  525.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L136" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    526. 

  526. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L136" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    527. 

  527. 

  528.   </dd>
    529. 

  529. </div>
    530. 

  530. 

  531. </div>
    532. 

  532. <div id="card-procs-all">
    533. 

  533.   <div id="card,HashSet[A]">
    534. 

  534.   <dt><pre><span class="Keyword">proc</span> <a href="#card%2CHashSet%5BA%5D"><span class="Identifier">card</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    535. 

  535.   <dd>
    536. 

  536.     
    537. 

  537.     <p>Alias for <a class="reference external" href="#len,HashSet[A]">len()</a>.</p>
    538. 

  538. <p>Card stands for the <a class="reference external" href="https://en.wikipedia.org/wiki/Cardinality">cardinality</a> of a set.</p>
    539. 

  539. 

  540.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L186" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    541. 

  541. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L186" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    542. 

  542. 

  543.   </dd>
    544. 

  544. </div>
    545. 

  545. <div id="card,OrderedSet[A]">
    546. 

  546.   <dt><pre><span class="Keyword">proc</span> <a href="#card%2COrderedSet%5BA%5D"><span class="Identifier">card</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
    547. 

  547.   <dd>
    548. 

  548.     
    549. 

  549.     <p>Alias for <a class="reference external" href="#len,OrderedSet[A]">len()</a>.</p>
    550. 

  550. <p>Card stands for the <a class="reference external" href="https://en.wikipedia.org/wiki/Cardinality">cardinality</a> of a set.</p>
    551. 

  551. 

  552.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L839" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    553. 

  553. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L839" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    554. 

  554. 

  555.   </dd>
    556. 

  556. </div>
    557. 

  557. 

  558. </div>
    559. 

  559. <div id="clear-procs-all">
    560. 

  560.   <div id="clear,HashSet[A]">
    561. 

  561.   <dt><pre><span class="Keyword">proc</span> <a href="#clear%2CHashSet%5BA%5D"><span class="Identifier">clear</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    562. 

  562.   <dd>
    563. 

  563.     
    564. 

  564.     <p>Clears the HashSet back to an empty state, without shrinking any of the existing storage.</p>
    565. 

  565. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">)</span></span></tt> operation, where <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> is the size of the hash bucket.</p>
    566. 

  566. <p>See also:</p>
    567. 

  567. <ul class="simple"><li><a class="reference external" href="#pop,HashSet[A]">pop proc</a></li>
    568. 

  568. </ul>
    569. 

  569. 

  570. <p><strong class="examples_text">Example:</strong></p>
    571. 

  571. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    572. 

  572. <span class="Identifier">clear</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span>
    573. 

  573. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
    574. 

  574.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L369" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    575. 

  575. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L369" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    576. 

  576. 

  577.   </dd>
    578. 

  578. </div>
    579. 

  579. <div id="clear,OrderedSet[A]">
    580. 

  580.   <dt><pre><span class="Keyword">proc</span> <a href="#clear%2COrderedSet%5BA%5D"><span class="Identifier">clear</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    581. 

  581.   <dd>
    582. 

  582.     
    583. 

  583.     <p>Clears the OrderedSet back to an empty state, without shrinking any of the existing storage.</p>
    584. 

  584. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">)</span></span></tt> operation where <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> is the size of the hash bucket.</p>
    585. 

  585. 

  586. <p><strong class="examples_text">Example:</strong></p>
    587. 

  587. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    588. 

  588. <span class="Identifier">clear</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span>
    589. 

  589. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
    590. 

  590.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L805" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    591. 

  591. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L805" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    592. 

  592. 

  593.   </dd>
    594. 

  594. </div>
    595. 

  595. 

  596. </div>
    597. 

  597. <div id="contains-procs-all">
    598. 

  598.   <div id="contains,HashSet[A],A">
    599. 

  599.   <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CHashSet%5BA%5D%2CA"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    600. 

  600.   <dd>
    601. 

  601.     
    602. 

  602.     <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    603. 

  603. <p>This allows the usage of <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> operator.</p>
    604. 

  604. <p>See also:</p>
    605. 

  605. <ul class="simple"><li><a class="reference external" href="#incl,HashSet[A],A">incl proc</a></li>
    606. 

  606. <li><a class="reference external" href="#containsOrIncl,HashSet[A],A">containsOrIncl proc</a></li>
    607. 

  607. </ul>
    608. 

  608. 

  609. <p><strong class="examples_text">Example:</strong></p>
    610. 

  610. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initHashSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    611. 

  611. <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Keyword">not</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    612. 

  612. <span class="Identifier">assert</span> <span class="DecNumber">2</span> <span class="Keyword">notin</span> <span class="Identifier">values</span>
    613. 

  613. 

  614. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    615. 

  615. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    616. 

  616. <span class="Identifier">assert</span> <span class="DecNumber">2</span> <span class="Keyword">in</span> <span class="Identifier">values</span></pre>
    617. 

  617.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L151" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    618. 

  618. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L151" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    619. 

  619. 

  620.   </dd>
    621. 

  621. </div>
    622. 

  622. <div id="contains,OrderedSet[A],A">
    623. 

  623.   <dt><pre><span class="Keyword">proc</span> <a href="#contains%2COrderedSet%5BA%5D%2CA"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    624. 

  624.   <dd>
    625. 

  625.     
    626. 

  626.     <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    627. 

  627. <p>This allows the usage of <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> operator.</p>
    628. 

  628. <p>See also:</p>
    629. 

  629. <ul class="simple"><li><a class="reference external" href="#incl,OrderedSet[A],A">incl proc</a></li>
    630. 

  630. <li><a class="reference external" href="#containsOrIncl,OrderedSet[A],A">containsOrIncl proc</a></li>
    631. 

  631. </ul>
    632. 

  632. 

  633. <p><strong class="examples_text">Example:</strong></p>
    634. 

  634. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initOrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    635. 

  635. <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Keyword">not</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    636. 

  636. <span class="Identifier">assert</span> <span class="DecNumber">2</span> <span class="Keyword">notin</span> <span class="Identifier">values</span>
    637. 

  637. 

  638. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    639. 

  639. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    640. 

  640. <span class="Identifier">assert</span> <span class="DecNumber">2</span> <span class="Keyword">in</span> <span class="Identifier">values</span></pre>
    641. 

  641.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L696" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    642. 

  642. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L696" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    643. 

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. 

  647. </div>
    648. 

  648. <div id="containsOrIncl-procs-all">
    649. 

  649.   <div id="containsOrIncl,HashSet[A],A">
    650. 

  650.   <dt><pre><span class="Keyword">proc</span> <a href="#containsOrIncl%2CHashSet%5BA%5D%2CA"><span class="Identifier">containsOrIncl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    651. 

  651.   <dd>
    652. 

  652.     
    653. 

  653.     <p>Includes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and tells if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was already in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    654. 

  654. <p>The difference with regards to the <a class="reference external" href="#incl,HashSet[A],A">incl proc</a> is that this proc returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> already contained <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>. The proc will return <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was added as a new value to <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> during this call.</p>
    655. 

  655. <p>See also:</p>
    656. 

  656. <ul class="simple"><li><a class="reference external" href="#incl,HashSet[A],A">incl proc</a> for including an element</li>
    657. 

  657. <li><a class="reference external" href="#incl,HashSet[A],HashSet[A]">incl proc</a> for including other set</li>
    658. 

  658. <li><a class="reference external" href="#missingOrExcl,HashSet[A],A">missingOrExcl proc</a></li>
    659. 

  659. </ul>
    660. 

  660. 

  661. <p><strong class="examples_text">Example:</strong></p>
    662. 

  662. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initHashSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    663. 

  663. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    664. 

  664. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    665. 

  665. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span></pre>
    666. 

  666.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L274" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    667. 

  667. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L274" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    668. 

  668. 

  669.   </dd>
    670. 

  670. </div>
    671. 

  671. <div id="containsOrIncl,OrderedSet[A],A">
    672. 

  672.   <dt><pre><span class="Keyword">proc</span> <a href="#containsOrIncl%2COrderedSet%5BA%5D%2CA"><span class="Identifier">containsOrIncl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    673. 

  673.   <dd>
    674. 

  674.     
    675. 

  675.     <p>Includes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and tells if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was already in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    676. 

  676. <p>The difference with regards to the <a class="reference external" href="#incl,OrderedSet[A],A">incl proc</a> is that this proc returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> already contained <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>. The proc will return false if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was added as a new value to <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> during this call.</p>
    677. 

  677. <p>See also:</p>
    678. 

  678. <ul class="simple"><li><a class="reference external" href="#incl,OrderedSet[A],A">incl proc</a> for including an element</li>
    679. 

  679. <li><a class="reference external" href="#missingOrExcl,OrderedSet[A],A">missingOrExcl proc</a></li>
    680. 

  680. </ul>
    681. 

  681. 

  682. <p><strong class="examples_text">Example:</strong></p>
    683. 

  683. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initOrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    684. 

  684. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    685. 

  685. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    686. 

  686. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">containsOrIncl</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span></pre>
    687. 

  687.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L750" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    688. 

  688. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L750" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    689. 

  689. 

  690.   </dd>
    691. 

  691. </div>
    692. 

  692. 

  693. </div>
    694. 

  694. <div id="difference-procs-all">
    695. 

  695.   <div id="difference,HashSet[A],HashSet[A]">
    696. 

  696.   <dt><pre><span class="Keyword">proc</span> <a href="#difference%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">difference</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    697. 

  697.   <dd>
    698. 

  698.     
    699. 

  699.     <p>Returns the difference of the sets <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt>.</p>
    700. 

  700. <p>The same as <a class="reference external" href="#-,HashSet[A],HashSet[A]">s1 - s2</a>.</p>
    701. 

  701. <p>The difference of two sets is represented mathematically as <em>A ∖ B</em> and is the set of all objects that are members of <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and not members of <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt>.</p>
    702. 

  702. <p>See also:</p>
    703. 

  703. <ul class="simple"><li><a class="reference external" href="#union,HashSet[A],HashSet[A]">union proc</a></li>
    704. 

  704. <li><a class="reference external" href="#intersection,HashSet[A],HashSet[A]">intersection proc</a></li>
    705. 

  705. <li><a class="reference external" href="#symmetricDifference,HashSet[A],HashSet[A]">symmetricDifference proc</a></li>
    706. 

  706. </ul>
    707. 

  707. 

  708. <p><strong class="examples_text">Example:</strong></p>
    709. 

  709. <pre class="listing"><span class="Keyword">let</span>
    710. 

  710.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    711. 

  711.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    712. 

  712.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">difference</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    713. 

  713. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    714. 

  714.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L443" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    715. 

  715. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L443" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    716. 

  716. 

  717.   </dd>
    718. 

  718. </div>
    719. 

  719. 

  720. </div>
    721. 

  721. <div id="disjoint-procs-all">
    722. 

  722.   <div id="disjoint,HashSet[A],HashSet[A]">
    723. 

  723.   <dt><pre><span class="Keyword">proc</span> <a href="#disjoint%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">disjoint</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    724. 

  724.   <dd>
    725. 

  725.     
    726. 

  726.     Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if the sets <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt> have no items in common.
    727. 

  727. <p><strong class="examples_text">Example:</strong></p>
    728. 

  728. <pre class="listing"><span class="Keyword">let</span>
    729. 

  729.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    730. 

  730.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    731. 

  731. <span class="Identifier">assert</span> <span class="Identifier">disjoint</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    732. 

  732. <span class="Identifier">assert</span> <span class="Identifier">disjoint</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span> <span class="Operator">-</span> <span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span></pre>
    733. 

  733.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L508" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    734. 

  734. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L508" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    735. 

  735. 

  736.   </dd>
    737. 

  737. </div>
    738. 

  738. 

  739. </div>
    740. 

  740. <div id="excl-procs-all">
    741. 

  741.   <div id="excl,HashSet[A],A">
    742. 

  742.   <dt><pre><span class="Keyword">proc</span> <a href="#excl%2CHashSet%5BA%5D%2CA"><span class="Identifier">excl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span></pre></dt>
    743. 

  743.   <dd>
    744. 

  744.     
    745. 

  745.     <p>Excludes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    746. 

  746. <p>This doesn't do anything if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is not found in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    747. 

  747. <p>See also:</p>
    748. 

  748. <ul class="simple"><li><a class="reference external" href="#incl,HashSet[A],A">incl proc</a> for including an element</li>
    749. 

  749. <li><a class="reference external" href="#excl,HashSet[A],HashSet[A]">excl proc</a> for excluding other set</li>
    750. 

  750. <li><a class="reference external" href="#missingOrExcl,HashSet[A],A">missingOrExcl proc</a></li>
    751. 

  751. </ul>
    752. 

  752. 

  753. <p><strong class="examples_text">Example:</strong></p>
    754. 

  754. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    755. 

  755. <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    756. 

  756. <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    757. 

  757. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    758. 

  758.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L294" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    759. 

  759. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L294" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    760. 

  760. 

  761.   </dd>
    762. 

  762. </div>
    763. 

  763. <div id="excl,HashSet[A],HashSet[A]">
    764. 

  764.   <dt><pre><span class="Keyword">proc</span> <a href="#excl%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">excl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">other</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    765. 

  765.   <dd>
    766. 

  766.     
    767. 

  767.     <p>Excludes all elements of <tt class="docutils literal"><span class="pre"><span class="Identifier">other</span></span></tt> set from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    768. 

  768. <p>This is the in-place version of <a class="reference external" href="#-,HashSet[A],HashSet[A]">s - other</a>.</p>
    769. 

  769. <p>See also:</p>
    770. 

  770. <ul class="simple"><li><a class="reference external" href="#incl,HashSet[A],HashSet[A]">incl proc</a> for including other set</li>
    771. 

  771. <li><a class="reference external" href="#excl,HashSet[A],A">excl proc</a> for excluding an element</li>
    772. 

  772. <li><a class="reference external" href="#missingOrExcl,HashSet[A],A">missingOrExcl proc</a></li>
    773. 

  773. </ul>
    774. 

  774. 

  775. <p><strong class="examples_text">Example:</strong></p>
    776. 

  776. <pre class="listing"><span class="Keyword">var</span>
    777. 

  777.   <span class="Identifier">numbers</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    778. 

  778.   <span class="Identifier">even</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">8</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    779. 

  779. <span class="Identifier">numbers</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="Identifier">even</span><span class="Punctuation">)</span>
    780. 

  780. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">numbers</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    781. 

  781. <span class="Comment">## numbers == {1, 3, 5}</span></pre>
    782. 

  782.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L311" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    783. 

  783. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L311" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    784. 

  784. 

  785.   </dd>
    786. 

  786. </div>
    787. 

  787. <div id="excl,OrderedSet[A],A">
    788. 

  788.   <dt><pre><span class="Keyword">proc</span> <a href="#excl%2COrderedSet%5BA%5D%2CA"><span class="Identifier">excl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span></pre></dt>
    789. 

  789.   <dd>
    790. 

  790.     
    791. 

  791.     <p>Excludes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Efficiency: <tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">)</span></span></tt>.</p>
    792. 

  792. <p>This doesn't do anything if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is not found in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    793. 

  793. <p>See also:</p>
    794. 

  794. <ul class="simple"><li><a class="reference external" href="#incl,OrderedSet[A],A">incl proc</a> for including an element</li>
    795. 

  795. <li><a class="reference external" href="#missingOrExcl,OrderedSet[A],A">missingOrExcl proc</a></li>
    796. 

  796. </ul>
    797. 

  797. 

  798. <p><strong class="examples_text">Example:</strong></p>
    799. 

  799. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    800. 

  800. <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    801. 

  801. <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    802. 

  802. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    803. 

  803.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L769" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    804. 

  804. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L769" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    805. 

  805. 

  806.   </dd>
    807. 

  807. </div>
    808. 

  808. 

  809. </div>
    810. 

  810. <div id="hash-procs-all">
    811. 

  811.   <div id="hash,HashSet[A]">
    812. 

  812.   <dt><pre><span class="Keyword">proc</span> <a href="#hash%2CHashSet%5BA%5D"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
    813. 

  813.   <dd>
    814. 

  814.     
    815. 

  815.     Hashing of HashSet.
    816. 

  816.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L581" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    817. 

  817. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L581" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    818. 

  818. 

  819.   </dd>
    820. 

  820. </div>
    821. 

  821. <div id="hash,OrderedSet[A]">
    822. 

  822.   <dt><pre><span class="Keyword">proc</span> <a href="#hash%2COrderedSet%5BA%5D"><span class="Identifier">hash</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="hashes.html#Hash"><span class="Identifier">Hash</span></a></pre></dt>
    823. 

  823.   <dd>
    824. 

  824.     
    825. 

  825.     Hashing of OrderedSet.
    826. 

  826.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L870" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    827. 

  827. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L870" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    828. 

  828. 

  829.   </dd>
    830. 

  830. </div>
    831. 

  831. 

  832. </div>
    833. 

  833. <div id="incl-procs-all">
    834. 

  834.   <div id="incl,HashSet[A],A">
    835. 

  835.   <dt><pre><span class="Keyword">proc</span> <a href="#incl%2CHashSet%5BA%5D%2CA"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span></pre></dt>
    836. 

  836.   <dd>
    837. 

  837.     
    838. 

  838.     <p>Includes an element <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    839. 

  839. <p>This doesn't do anything if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is already in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    840. 

  840. <p>See also:</p>
    841. 

  841. <ul class="simple"><li><a class="reference external" href="#excl,HashSet[A],A">excl proc</a> for excluding an element</li>
    842. 

  842. <li><a class="reference external" href="#incl,HashSet[A],HashSet[A]">incl proc</a> for including other set</li>
    843. 

  843. <li><a class="reference external" href="#containsOrIncl,HashSet[A],A">containsOrIncl proc</a></li>
    844. 

  844. </ul>
    845. 

  845. 

  846. <p><strong class="examples_text">Example:</strong></p>
    847. 

  847. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initHashSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    848. 

  848. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    849. 

  849. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    850. 

  850. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">1</span></pre>
    851. 

  851.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L193" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    852. 

  852. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L193" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    853. 

  853. 

  854.   </dd>
    855. 

  855. </div>
    856. 

  856. <div id="incl,HashSet[A],HashSet[A]">
    857. 

  857.   <dt><pre><span class="Keyword">proc</span> <a href="#incl%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">other</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    858. 

  858.   <dd>
    859. 

  859.     
    860. 

  860.     <p>Includes all elements from <tt class="docutils literal"><span class="pre"><span class="Identifier">other</span></span></tt> set into <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> (must be declared as <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span></span></tt>).</p>
    861. 

  861. <p>This is the in-place version of <a class="reference external" href="#+,HashSet[A],HashSet[A]">s + other</a>.</p>
    862. 

  862. <p>See also:</p>
    863. 

  863. <ul class="simple"><li><a class="reference external" href="#excl,HashSet[A],HashSet[A]">excl proc</a> for excluding other set</li>
    864. 

  864. <li><a class="reference external" href="#incl,HashSet[A],A">incl proc</a> for including an element</li>
    865. 

  865. <li><a class="reference external" href="#containsOrIncl,HashSet[A],A">containsOrIncl proc</a></li>
    866. 

  866. </ul>
    867. 

  867. 

  868. <p><strong class="examples_text">Example:</strong></p>
    869. 

  869. <pre class="listing"><span class="Keyword">var</span>
    870. 

  870.   <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    871. 

  871.   <span class="Identifier">others</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    872. 

  872. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Identifier">others</span><span class="Punctuation">)</span>
    873. 

  873. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">5</span></pre>
    874. 

  874.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L210" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    875. 

  875. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L210" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    876. 

  876. 

  877.   </dd>
    878. 

  878. </div>
    879. 

  879. <div id="incl,HashSet[A],OrderedSet[A]">
    880. 

  880.   <dt><pre><span class="Keyword">proc</span> <a href="#incl%2CHashSet%5BA%5D%2COrderedSet%5BA%5D"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">other</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    881. 

  881.   <dd>
    882. 

  882.     
    883. 

  883.     <p>Includes all elements from the OrderedSet <tt class="docutils literal"><span class="pre"><span class="Identifier">other</span></span></tt> into HashSet <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> (must be declared as <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span></span></tt>).</p>
    884. 

  884. <p>See also:</p>
    885. 

  885. <ul class="simple"><li><a class="reference external" href="#incl,OrderedSet[A],A">incl proc</a> for including an element</li>
    886. 

  886. <li><a class="reference external" href="#containsOrIncl,OrderedSet[A],A">containsOrIncl proc</a></li>
    887. 

  887. </ul>
    888. 

  888. 

  889. <p><strong class="examples_text">Example:</strong></p>
    890. 

  890. <pre class="listing"><span class="Keyword">var</span>
    891. 

  891.   <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    892. 

  892.   <span class="Identifier">others</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    893. 

  893. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Identifier">others</span><span class="Punctuation">)</span>
    894. 

  894. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">5</span></pre>
    895. 

  895.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L734" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    896. 

  896. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L734" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    897. 

  897. 

  898.   </dd>
    899. 

  899. </div>
    900. 

  900. <div id="incl,OrderedSet[A],A">
    901. 

  901.   <dt><pre><span class="Keyword">proc</span> <a href="#incl%2COrderedSet%5BA%5D%2CA"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span></pre></dt>
    902. 

  902.   <dd>
    903. 

  903.     
    904. 

  904.     <p>Includes an element <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    905. 

  905. <p>This doesn't do anything if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is already in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    906. 

  906. <p>See also:</p>
    907. 

  907. <ul class="simple"><li><a class="reference external" href="#excl,OrderedSet[A],A">excl proc</a> for excluding an element</li>
    908. 

  908. <li><a class="reference external" href="#incl,HashSet[A],OrderedSet[A]">incl proc</a> for including other set</li>
    909. 

  909. <li><a class="reference external" href="#containsOrIncl,OrderedSet[A],A">containsOrIncl proc</a></li>
    910. 

  910. </ul>
    911. 

  911. 

  912. <p><strong class="examples_text">Example:</strong></p>
    913. 

  913. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">values</span> <span class="Operator">=</span> <span class="Identifier">initOrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    914. 

  914. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    915. 

  915. <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
    916. 

  916. <span class="Identifier">assert</span> <span class="Identifier">values</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">1</span></pre>
    917. 

  917.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L717" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    918. 

  918. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L717" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    919. 

  919. 

  920.   </dd>
    921. 

  921. </div>
    922. 

  922. 

  923. </div>
    924. 

  924. <div id="init-procs-all">
    925. 

  925.   <div id="init,HashSet[A]">
    926. 

  926.   <dt><pre><span class="Keyword">proc</span> <a href="#init%2CHashSet%5BA%5D"><span class="Identifier">init</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">initialSize</span> <span class="Other">=</span> <span class="Identifier">defaultInitialSize</span><span class="Other">)</span></pre></dt>
    927. 

  927.   <dd>
    928. 

  928.     
    929. 

  929.     <p>Initializes a hash set.</p>
    930. 

  930. <p>Starting from Nim v0.20, sets are initialized by default and it is not necessary to call this function explicitly.</p>
    931. 

  931. <p>You can call this proc on a previously initialized hash set, which will discard all its values. This might be more convenient than iterating over existing values and calling <a class="reference external" href="#excl,HashSet[A],A">excl()</a> on them.</p>
    932. 

  932. <p>See also:</p>
    933. 

  933. <ul class="simple"><li><a class="reference external" href="#initHashSet">initHashSet proc</a></li>
    934. 

  934. <li><a class="reference external" href="#toHashSet,openArray[A]">toHashSet proc</a></li>
    935. 

  935. </ul>
    936. 

  936. 

  937. <p><strong class="examples_text">Example:</strong></p>
    938. 

  938. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">HashSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span>
    939. 

  939. <span class="Identifier">init</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span></pre>
    940. 

  940.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L98" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    941. 

  941. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L98" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    942. 

  942. 

  943.   </dd>
    944. 

  944. </div>
    945. 

  945. <div id="init,OrderedSet[A]">
    946. 

  946.   <dt><pre><span class="Keyword">proc</span> <a href="#init%2COrderedSet%5BA%5D"><span class="Identifier">init</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">initialSize</span> <span class="Other">=</span> <span class="Identifier">defaultInitialSize</span><span class="Other">)</span></pre></dt>
    947. 

  947.   <dd>
    948. 

  948.     
    949. 

  949.     <p>Initializes an ordered hash set.</p>
    950. 

  950. <p>Starting from Nim v0.20, sets are initialized by default and it is not necessary to call this function explicitly.</p>
    951. 

  951. <p>You can call this proc on a previously initialized hash set, which will discard all its values. This might be more convenient than iterating over existing values and calling <a class="reference external" href="#excl,HashSet[A],A">excl()</a> on them.</p>
    952. 

  952. <p>See also:</p>
    953. 

  953. <ul class="simple"><li><a class="reference external" href="#initOrderedSet">initOrderedSet proc</a></li>
    954. 

  954. <li><a class="reference external" href="#toOrderedSet,openArray[A]">toOrderedSet proc</a></li>
    955. 

  955. </ul>
    956. 

  956. 

  957. <p><strong class="examples_text">Example:</strong></p>
    958. 

  958. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">OrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span>
    959. 

  959. <span class="Identifier">init</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span></pre>
    960. 

  960.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L638" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    961. 

  961. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L638" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    962. 

  962. 

  963.   </dd>
    964. 

  964. </div>
    965. 

  965. 

  966. </div>
    967. 

  967. <div id="initHashSet-procs-all">
    968. 

  968.   <div id="initHashSet">
    969. 

  969.   <dt><pre><span class="Keyword">proc</span> <a href="#initHashSet"><span class="Identifier">initHashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">initialSize</span> <span class="Other">=</span> <span class="Identifier">defaultInitialSize</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    970. 

  970.   <dd>
    971. 

  971.     
    972. 

  972.     <p>Wrapper around <a class="reference external" href="#init,HashSet[A]">init proc</a> for initialization of hash sets.</p>
    973. 

  973. <p>Returns an empty hash set you can assign directly in <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span></span></tt> blocks in a single line.</p>
    974. 

  974. <p>Starting from Nim v0.20, sets are initialized by default and it is not necessary to call this function explicitly.</p>
    975. 

  975. <p>See also:</p>
    976. 

  976. <ul class="simple"><li><a class="reference external" href="#toHashSet,openArray[A]">toHashSet proc</a></li>
    977. 

  977. </ul>
    978. 

  978. 

  979. <p><strong class="examples_text">Example:</strong></p>
    980. 

  980. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">initHashSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    981. 

  981. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
    982. 

  982. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span></pre>
    983. 

  983.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L117" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    984. 

  984. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L117" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    985. 

  985. 

  986.   </dd>
    987. 

  987. </div>
    988. 

  988. 

  989. </div>
    990. 

  990. <div id="initOrderedSet-procs-all">
    991. 

  991.   <div id="initOrderedSet">
    992. 

  992.   <dt><pre><span class="Keyword">proc</span> <a href="#initOrderedSet"><span class="Identifier">initOrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">initialSize</span> <span class="Other">=</span> <span class="Identifier">defaultInitialSize</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    993. 

  993.   <dd>
    994. 

  994.     
    995. 

  995.     <p>Wrapper around <a class="reference external" href="#init,OrderedSet[A]">init proc</a> for initialization of ordered hash sets.</p>
    996. 

  996. <p>Returns an empty ordered hash set you can assign directly in <tt class="docutils literal"><span class="pre"><span class="Keyword">var</span></span></tt> blocks in a single line.</p>
    997. 

  997. <p>Starting from Nim v0.20, sets are initialized by default and it is not necessary to call this function explicitly.</p>
    998. 

  998. <p>See also:</p>
    999. 

  999. <ul class="simple"><li><a class="reference external" href="#toOrderedSet,openArray[A]">toOrderedSet proc</a></li>
    1000. 

  1000. </ul>
    1001. 

  1001. 

  1002. <p><strong class="examples_text">Example:</strong></p>
    1003. 

  1003. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">initOrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1004. 

  1004. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
    1005. 

  1005. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span></pre>
    1006. 

  1006.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L657" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1007. 

  1007. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L657" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1008. 

  1008. 

  1009.   </dd>
    1010. 

  1010. </div>
    1011. 

  1011. 

  1012. </div>
    1013. 

  1013. <div id="initSet-procs-all">
    1014. 

  1014.   <div id="initSet">
    1015. 

  1015.   <dt><pre><span class="Keyword">proc</span> <a href="#initSet"><span class="Identifier">initSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">initialSize</span> <span class="Other">=</span> <span class="Identifier">defaultInitialSize</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.
    1016. 

  1016.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;Deprecated since v0.20, use \'initHashSet\'&quot;</span></span>.}</pre></dt>
    1017. 

  1017.   <dd>
    1018. 

  1018.     <div class="deprecation-message">
    1019. 

  1019.   <b>Deprecated:</b> Deprecated since v0.20, use &apos;initHashSet&apos;
    1020. 

  1020. </div>
    1021. 

  1021. 

  1022.     
    1023. 

  1023.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L603" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1024. 

  1024. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L603" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1025. 

  1025. 

  1026.   </dd>
    1027. 

  1027. </div>
    1028. 

  1028. 

  1029. </div>
    1030. 

  1030. <div id="intersection-procs-all">
    1031. 

  1031.   <div id="intersection,HashSet[A],HashSet[A]">
    1032. 

  1032.   <dt><pre><span class="Keyword">proc</span> <a href="#intersection%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">intersection</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1033. 

  1033.   <dd>
    1034. 

  1034.     
    1035. 

  1035.     <p>Returns the intersection of the sets <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt>.</p>
    1036. 

  1036. <p>The same as <a class="reference external" href="#*,HashSet[A],HashSet[A]">s1 * s2</a>.</p>
    1037. 

  1037. <p>The intersection of two sets is represented mathematically as <em>A ∩ B</em> and is the set of all objects that are members of <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt> at the same time.</p>
    1038. 

  1038. <p>See also:</p>
    1039. 

  1039. <ul class="simple"><li><a class="reference external" href="#union,HashSet[A],HashSet[A]">union proc</a></li>
    1040. 

  1040. <li><a class="reference external" href="#difference,HashSet[A],HashSet[A]">difference proc</a></li>
    1041. 

  1041. <li><a class="reference external" href="#symmetricDifference,HashSet[A],HashSet[A]">symmetricDifference proc</a></li>
    1042. 

  1042. </ul>
    1043. 

  1043. 

  1044. <p><strong class="examples_text">Example:</strong></p>
    1045. 

  1045. <pre class="listing"><span class="Keyword">let</span>
    1046. 

  1046.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1047. 

  1047.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1048. 

  1048.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">intersection</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    1049. 

  1049. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    1050. 

  1050.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L412" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1051. 

  1051. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L412" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1052. 

  1052. 

  1053.   </dd>
    1054. 

  1054. </div>
    1055. 

  1055. 

  1056. </div>
    1057. 

  1057. <div id="isValid-procs-all">
    1058. 

  1058.   <div id="isValid,HashSet[A]">
    1059. 

  1059.   <dt><pre><span class="Keyword">proc</span> <a href="#isValid%2CHashSet%5BA%5D"><span class="Identifier">isValid</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;Deprecated since v0.20; sets are initialized by default&quot;</span></span>.}</pre></dt>
    1060. 

  1060.   <dd>
    1061. 

  1061.     <div class="deprecation-message">
    1062. 

  1062.   <b>Deprecated:</b> Deprecated since v0.20; sets are initialized by default
    1063. 

  1063. </div>
    1064. 

  1064. 

  1065.     Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if the set has been initialized (with <a class="reference external" href="#initHashSet">initHashSet proc</a> or <a class="reference external" href="#init,HashSet[A]">init proc</a>). 
    1066. 

  1066. <p><strong class="examples_text">Example:</strong></p>
    1067. 

  1067. <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">savePreferences</span><span class="Punctuation">(</span><span class="Identifier">options</span><span class="Punctuation">:</span> <span class="Identifier">HashSet</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    1068. 

  1068.   <span class="Identifier">assert</span> <span class="Identifier">options</span><span class="Operator">.</span><span class="Identifier">isValid</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Pass an initialized set!&quot;</span>
    1069. 

  1069.   <span class="Comment"># Do stuff here, may crash in release builds!</span></pre>
    1070. 

  1070.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L609" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1071. 

  1071. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L609" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1072. 

  1072. 

  1073.   </dd>
    1074. 

  1074. </div>
    1075. 

  1075. 

  1076. </div>
    1077. 

  1077. <div id="len-procs-all">
    1078. 

  1078.   <div id="len,HashSet[A]">
    1079. 

  1079.   <dt><pre><span class="Keyword">proc</span> <a href="#len%2CHashSet%5BA%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
    1080. 

  1080.   <dd>
    1081. 

  1081.     
    1082. 

  1082.     <p>Returns the number of elements in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1083. 

  1083. <p>Due to an implementation detail you can call this proc on variables which have not been initialized yet. The proc will return zero as the length then.</p>
    1084. 

  1084. 

  1085. <p><strong class="examples_text">Example:</strong></p>
    1086. 

  1086. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">HashSet</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
    1087. 

  1087. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1088. 

  1088. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1089. 

  1089. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    1090. 

  1090.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L172" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1091. 

  1091. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L172" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1092. 

  1092. 

  1093.   </dd>
    1094. 

  1094. </div>
    1095. 

  1095. <div id="len,OrderedSet[A]">
    1096. 

  1096.   <dt><pre><span class="Keyword">proc</span> <a href="#len%2COrderedSet%5BA%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
    1097. 

  1097.   <dd>
    1098. 

  1098.     
    1099. 

  1099.     <p>Returns the number of elements in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1100. 

  1100. <p>Due to an implementation detail you can call this proc on variables which have not been initialized yet. The proc will return zero as the length then.</p>
    1101. 

  1101. 

  1102. <p><strong class="examples_text">Example:</strong></p>
    1103. 

  1103. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">OrderedSet</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
    1104. 

  1104. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
    1105. 

  1105. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1106. 

  1106. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
    1107. 

  1107.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L825" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1108. 

  1108. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L825" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1109. 

  1109. 

  1110.   </dd>
    1111. 

  1111. </div>
    1112. 

  1112. 

  1113. </div>
    1114. 

  1114. <div id="map-procs-all">
    1115. 

  1115.   <div id="map,HashSet[A],proc(A)">
    1116. 

  1116.   <dt><pre><span class="Keyword">proc</span> <a href="#map%2CHashSet%5BA%5D%2Cproc%28A%29"><span class="Identifier">map</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">,</span> <span class="Identifier">B</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">op</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">B</span> {.<span class="Identifier">closure</span>.}<span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">B</span><span class="Other">]</span> {.
    1117. 

  1117.     <span class="Identifier">effectsOf</span><span class="Other">:</span> <span class="Identifier">op</span>.}</pre></dt>
    1118. 

  1118.   <dd>
    1119. 

  1119.     
    1120. 

  1120.     <p>Returns a new set after applying <tt class="docutils literal"><span class="pre"><span class="Identifier">op</span></span></tt> proc on each of the elements of <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt> set.</p>
    1121. 

  1121. <p>You can use this proc to transform the elements from a set.</p>
    1122. 

  1122. 

  1123. <p><strong class="examples_text">Example:</strong></p>
    1124. 

  1124. <pre class="listing"><span class="Keyword">let</span>
    1125. 

  1125.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1126. 

  1126.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">map</span><span class="Punctuation">(</span><span class="Keyword">proc</span> <span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span> <span class="Operator">$</span><span class="Identifier">x</span><span class="Punctuation">)</span>
    1127. 

  1127. <span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;3&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    1128. 

  1128.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L567" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1129. 

  1129. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L567" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1130. 

  1130. 

  1131.   </dd>
    1132. 

  1132. </div>
    1133. 

  1133. 

  1134. </div>
    1135. 

  1135. <div id="missingOrExcl-procs-all">
    1136. 

  1136.   <div id="missingOrExcl,HashSet[A],A">
    1137. 

  1137.   <dt><pre><span class="Keyword">proc</span> <a href="#missingOrExcl%2CHashSet%5BA%5D%2CA"><span class="Identifier">missingOrExcl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    1138. 

  1138.   <dd>
    1139. 

  1139.     
    1140. 

  1140.     <p>Excludes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and tells if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was already missing from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1141. 

  1141. <p>The difference with regards to the <a class="reference external" href="#excl,HashSet[A],A">excl proc</a> is that this proc returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was missing from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. The proc will return <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and it was removed during this call.</p>
    1142. 

  1142. <p>See also:</p>
    1143. 

  1143. <ul class="simple"><li><a class="reference external" href="#excl,HashSet[A],A">excl proc</a> for excluding an element</li>
    1144. 

  1144. <li><a class="reference external" href="#excl,HashSet[A],HashSet[A]">excl proc</a> for excluding other set</li>
    1145. 

  1145. <li><a class="reference external" href="#containsOrIncl,HashSet[A],A">containsOrIncl proc</a></li>
    1146. 

  1146. </ul>
    1147. 

  1147. 

  1148. <p><strong class="examples_text">Example:</strong></p>
    1149. 

  1149. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1150. 

  1150. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1151. 

  1151. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    1152. 

  1152. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span></pre>
    1153. 

  1153.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L330" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1154. 

  1154. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L330" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1155. 

  1155. 

  1156.   </dd>
    1157. 

  1157. </div>
    1158. 

  1158. <div id="missingOrExcl,OrderedSet[A],A">
    1159. 

  1159.   <dt><pre><span class="Keyword">proc</span> <a href="#missingOrExcl%2COrderedSet%5BA%5D%2CA"><span class="Identifier">missingOrExcl</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    1160. 

  1160.   <dd>
    1161. 

  1161.     
    1162. 

  1162.     <p>Excludes <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and tells if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was already missing from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. Efficiency: O(n).</p>
    1163. 

  1163. <p>The difference with regards to the <a class="reference external" href="#excl,OrderedSet[A],A">excl proc</a> is that this proc returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was missing from <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>. The proc will return <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> was in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and it was removed during this call.</p>
    1164. 

  1164. <p>See also:</p>
    1165. 

  1165. <ul class="simple"><li><a class="reference external" href="#excl,OrderedSet[A],A">excl proc</a></li>
    1166. 

  1166. <li><a class="reference external" href="#containsOrIncl,OrderedSet[A],A">containsOrIncl proc</a></li>
    1167. 

  1167. </ul>
    1168. 

  1168. 

  1169. <p><strong class="examples_text">Example:</strong></p>
    1170. 

  1170. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1171. 

  1171. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span>
    1172. 

  1172. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span>
    1173. 

  1173. <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">missingOrExcl</span><span class="Punctuation">(</span><span class="DecNumber">6</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span></pre>
    1174. 

  1174.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L785" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1175. 

  1175. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L785" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1176. 

  1176. 

  1177.   </dd>
    1178. 

  1178. </div>
    1179. 

  1179. 

  1180. </div>
    1181. 

  1181. <div id="pop-procs-all">
    1182. 

  1182.   <div id="pop,HashSet[A]">
    1183. 

  1183.   <dt><pre><span class="Keyword">proc</span> <a href="#pop%2CHashSet%5BA%5D"><span class="Identifier">pop</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">A</span></pre></dt>
    1184. 

  1184.   <dd>
    1185. 

  1185.     
    1186. 

  1186.     <p>Removes and returns an arbitrary element from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1187. 

  1187. <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">KeyError</span></span></tt> if the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> is empty.</p>
    1188. 

  1188. <p>See also:</p>
    1189. 

  1189. <ul class="simple"><li><a class="reference external" href="#clear,HashSet[A]">clear proc</a></li>
    1190. 

  1190. </ul>
    1191. 

  1191. 

  1192. <p><strong class="examples_text">Example:</strong></p>
    1193. 

  1193. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1194. 

  1194. <span class="Identifier">assert</span> <span class="Punctuation">[</span><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">pop</span><span class="Punctuation">,</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">pop</span><span class="Punctuation">]</span> <span class="Keyword">in</span> <span class="Punctuation">[</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">]</span> <span class="Comment"># order unspecified</span>
    1195. 

  1195. <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">KeyError</span><span class="Punctuation">,</span> <span class="Identifier">echo</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">pop</span><span class="Punctuation">)</span></pre>
    1196. 

  1196.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L350" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1197. 

  1197. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L350" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1198. 

  1198. 

  1199.   </dd>
    1200. 

  1200. </div>
    1201. 

  1201. 

  1202. </div>
    1203. 

  1203. <div id="symmetricDifference-procs-all">
    1204. 

  1204.   <div id="symmetricDifference,HashSet[A],HashSet[A]">
    1205. 

  1205.   <dt><pre><span class="Keyword">proc</span> <a href="#symmetricDifference%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">symmetricDifference</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1206. 

  1206.   <dd>
    1207. 

  1207.     
    1208. 

  1208.     <p>Returns the symmetric difference of the sets <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt>.</p>
    1209. 

  1209. <p>The same as <a class="reference external" href="#-+-,HashSet[A],HashSet[A]">s1 -+- s2</a>.</p>
    1210. 

  1210. <p>The symmetric difference of two sets is represented mathematically as <em>A △ B</em> or <em>A ⊖ B</em> and is the set of all objects that are members of <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt> but not both at the same time.</p>
    1211. 

  1211. <p>See also:</p>
    1212. 

  1212. <ul class="simple"><li><a class="reference external" href="#union,HashSet[A],HashSet[A]">union proc</a></li>
    1213. 

  1213. <li><a class="reference external" href="#intersection,HashSet[A],HashSet[A]">intersection proc</a></li>
    1214. 

  1214. <li><a class="reference external" href="#difference,HashSet[A],HashSet[A]">difference proc</a></li>
    1215. 

  1215. </ul>
    1216. 

  1216. 

  1217. <p><strong class="examples_text">Example:</strong></p>
    1218. 

  1218. <pre class="listing"><span class="Keyword">let</span>
    1219. 

  1219.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1220. 

  1220.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1221. 

  1221.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">symmetricDifference</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    1222. 

  1222. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    1223. 

  1223.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L467" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1224. 

  1224. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L467" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1225. 

  1225. 

  1226.   </dd>
    1227. 

  1227. </div>
    1228. 

  1228. 

  1229. </div>
    1230. 

  1230. <div id="toHashSet-procs-all">
    1231. 

  1231.   <div id="toHashSet,openArray[A]">
    1232. 

  1232.   <dt><pre><span class="Keyword">proc</span> <a href="#toHashSet%2CopenArray%5BA%5D"><span class="Identifier">toHashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">keys</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1233. 

  1233.   <dd>
    1234. 

  1234.     
    1235. 

  1235.     <p>Creates a new hash set that contains the members of the given collection (seq, array, or string) <tt class="docutils literal"><span class="pre"><span class="Identifier">keys</span></span></tt>.</p>
    1236. 

  1236. <p>Duplicates are removed.</p>
    1237. 

  1237. <p>See also:</p>
    1238. 

  1238. <ul class="simple"><li><a class="reference external" href="#initHashSet">initHashSet proc</a></li>
    1239. 

  1239. </ul>
    1240. 

  1240. 

  1241. <p><strong class="examples_text">Example:</strong></p>
    1242. 

  1242. <pre class="listing"><span class="Keyword">let</span>
    1243. 

  1243.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1244. 

  1244.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="StringLit">&quot;abracadabra&quot;</span><span class="Punctuation">)</span>
    1245. 

  1245. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1246. 

  1246. <span class="Comment">## a == {2, 3, 5}</span>
    1247. 

  1247. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    1248. 

  1248. <span class="Comment">## b == {'a', 'b', 'c', 'd', 'r'}</span></pre>
    1249. 

  1249.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L228" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1250. 

  1250. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L228" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1251. 

  1251. 

  1252.   </dd>
    1253. 

  1253. </div>
    1254. 

  1254. 

  1255. </div>
    1256. 

  1256. <div id="toOrderedSet-procs-all">
    1257. 

  1257.   <div id="toOrderedSet,openArray[A]">
    1258. 

  1258.   <dt><pre><span class="Keyword">proc</span> <a href="#toOrderedSet%2CopenArray%5BA%5D"><span class="Identifier">toOrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">keys</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1259. 

  1259.   <dd>
    1260. 

  1260.     
    1261. 

  1261.     <p>Creates a new hash set that contains the members of the given collection (seq, array, or string) <tt class="docutils literal"><span class="pre"><span class="Identifier">keys</span></span></tt>.</p>
    1262. 

  1262. <p>Duplicates are removed.</p>
    1263. 

  1263. <p>See also:</p>
    1264. 

  1264. <ul class="simple"><li><a class="reference external" href="#initOrderedSet">initOrderedSet proc</a></li>
    1265. 

  1265. </ul>
    1266. 

  1266. 

  1267. <p><strong class="examples_text">Example:</strong></p>
    1268. 

  1268. <pre class="listing"><span class="Keyword">let</span>
    1269. 

  1269.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1270. 

  1270.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="StringLit">&quot;abracadabra&quot;</span><span class="Punctuation">)</span>
    1271. 

  1271. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
    1272. 

  1272. <span class="Comment">## a == {5, 3, 2} # different than in HashSet</span>
    1273. 

  1273. <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
    1274. 

  1274. <span class="Comment">## b == {'a', 'b', 'r', 'c', 'd'} # different than in HashSet</span></pre>
    1275. 

  1275.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L676" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1276. 

  1276. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L676" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1277. 

  1277. 

  1278.   </dd>
    1279. 

  1279. </div>
    1280. 

  1280. 

  1281. </div>
    1282. 

  1282. <div id="toSet-procs-all">
    1283. 

  1283.   <div id="toSet,openArray[A]">
    1284. 

  1284.   <dt><pre><span class="Keyword">proc</span> <a href="#toSet%2CopenArray%5BA%5D"><span class="Identifier">toSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">keys</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span> {.
    1285. 

  1285.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;Deprecated since v0.20, use \'toHashSet\'&quot;</span></span>.}</pre></dt>
    1286. 

  1286.   <dd>
    1287. 

  1287.     <div class="deprecation-message">
    1288. 

  1288.   <b>Deprecated:</b> Deprecated since v0.20, use &apos;toHashSet&apos;
    1289. 

  1289. </div>
    1290. 

  1290. 

  1291.     
    1292. 

  1292.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L606" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1293. 

  1293. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L606" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1294. 

  1294. 

  1295.   </dd>
    1296. 

  1296. </div>
    1297. 

  1297. 

  1298. </div>
    1299. 

  1299. <div id="union-procs-all">
    1300. 

  1300.   <div id="union,HashSet[A],HashSet[A]">
    1301. 

  1301.   <dt><pre><span class="Keyword">proc</span> <a href="#union%2CHashSet%5BA%5D%2CHashSet%5BA%5D"><span class="Identifier">union</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s1</span><span class="Other">,</span> <span class="Identifier">s2</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1302. 

  1302.   <dd>
    1303. 

  1303.     
    1304. 

  1304.     <p>Returns the union of the sets <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt>.</p>
    1305. 

  1305. <p>The same as <a class="reference external" href="#+,HashSet[A],HashSet[A]">s1 + s2</a>.</p>
    1306. 

  1306. <p>The union of two sets is represented mathematically as <em>A ∪ B</em> and is the set of all objects that are members of <tt class="docutils literal"><span class="pre"><span class="Identifier">s1</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">s2</span></span></tt> or both.</p>
    1307. 

  1307. <p>See also:</p>
    1308. 

  1308. <ul class="simple"><li><a class="reference external" href="#intersection,HashSet[A],HashSet[A]">intersection proc</a></li>
    1309. 

  1309. <li><a class="reference external" href="#difference,HashSet[A],HashSet[A]">difference proc</a></li>
    1310. 

  1310. <li><a class="reference external" href="#symmetricDifference,HashSet[A],HashSet[A]">symmetricDifference proc</a></li>
    1311. 

  1311. </ul>
    1312. 

  1312. 

  1313. <p><strong class="examples_text">Example:</strong></p>
    1314. 

  1314. <pre class="listing"><span class="Keyword">let</span>
    1315. 

  1315.   <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1316. 

  1316.   <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1317. 

  1317.   <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">union</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
    1318. 

  1318. <span class="Identifier">assert</span> <span class="Identifier">c</span> <span class="Operator">==</span> <span class="Identifier">toHashSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre>
    1319. 

  1319.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L390" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1320. 

  1320. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L390" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1321. 

  1321. 

  1322.   </dd>
    1323. 

  1323. </div>
    1324. 

  1324. 

  1325. </div>
    1326. 

  1326. 

  1327.   </dl>
    1328. 

  1328. </div>
    1329. 

  1329. <div class="section" id="15">
    1330. 

  1330.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    1331. 

  1331.   <dl class="item">
    1332. 

  1332.     <div id="items-iterators-all">
    1333. 

  1333.   <div id="items.i,HashSet[A]">
    1334. 

  1334.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CHashSet%5BA%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#HashSet"><span class="Identifier">HashSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">A</span></pre></dt>
    1335. 

  1335.   <dd>
    1336. 

  1336.     
    1337. 

  1337.     <p>Iterates over elements of the set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.</p>
    1338. 

  1338. <p>If you need a sequence with the elements you can use <a class="reference external" href="sequtils.html#toSeq.t,untyped">sequtils.toSeq template</a>.</p>
    1339. 

  1339. <p><pre class="listing"><span class="Keyword">type</span>
    1340. 

  1340.   <span class="Identifier">pair</span> <span class="Operator">=</span> <span class="Keyword">tuple</span><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">]</span>
    1341. 

  1341. <span class="Keyword">var</span>
    1342. 

  1342.   <span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">initHashSet</span><span class="Punctuation">[</span><span class="Identifier">pair</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1343. 

  1343. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    1344. 

  1344. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    1345. 

  1345. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    1346. 

  1346. <span class="Keyword">for</span> <span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span> <span class="Keyword">in</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">items</span><span class="Punctuation">:</span>
    1347. 

  1347.   <span class="Identifier">b</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Operator">-</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">y</span> <span class="Operator">+</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    1348. 

  1348. <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    1349. 

  1349. <span class="Identifier">echo</span> <span class="Identifier">b</span>
    1350. 

  1350. <span class="Comment"># --&gt; {(a: 1, b: 3), (a: 0, b: 4)}</span></pre></p>
    1351. 

  1351. 

  1352.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L248" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1353. 

  1353. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L248" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1354. 

  1354. 

  1355.   </dd>
    1356. 

  1356. </div>
    1357. 

  1357. <div id="items.i,OrderedSet[A]">
    1358. 

  1358.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2COrderedSet%5BA%5D"><span class="Identifier">items</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">A</span></pre></dt>
    1359. 

  1359.   <dd>
    1360. 

  1360.     
    1361. 

  1361.     <p>Iterates over keys in the ordered set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> in insertion order.</p>
    1362. 

  1362. <p>If you need a sequence with the elements you can use <a class="reference external" href="sequtils.html#toSeq.t,untyped">sequtils.toSeq template</a>.</p>
    1363. 

  1363. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">initOrderedSet</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1364. 

  1364. <span class="Keyword">for</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Punctuation">[</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">8</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">:</span>
    1365. 

  1365.   <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Identifier">value</span><span class="Punctuation">)</span>
    1366. 

  1366. <span class="Keyword">for</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">items</span><span class="Punctuation">:</span>
    1367. 

  1367.   <span class="Identifier">echo</span> <span class="StringLit">&quot;Got &quot;</span><span class="Punctuation">,</span> <span class="Identifier">value</span>
    1368. 

  1368. <span class="Comment"># --&gt; Got 9</span>
    1369. 

  1369. <span class="Comment"># --&gt; Got 2</span>
    1370. 

  1370. <span class="Comment"># --&gt; Got 1</span>
    1371. 

  1371. <span class="Comment"># --&gt; Got 5</span>
    1372. 

  1372. <span class="Comment"># --&gt; Got 8</span>
    1373. 

  1373. <span class="Comment"># --&gt; Got 4</span></pre></p>
    1374. 

  1374. 

  1375.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L894" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1376. 

  1376. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L894" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1377. 

  1377. 

  1378.   </dd>
    1379. 

  1379. </div>
    1380. 

  1380. 

  1381. </div>
    1382. 

  1382. <div id="pairs-iterators-all">
    1383. 

  1383.   <div id="pairs.i,OrderedSet[A]">
    1384. 

  1384.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2COrderedSet%5BA%5D"><span class="Identifier">pairs</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sets.html#OrderedSet"><span class="Identifier">OrderedSet</span></a><span class="Other">[</span><span class="Identifier">A</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">A</span><span class="Other">]</span></pre></dt>
    1385. 

  1385.   <dd>
    1386. 

  1386.     
    1387. 

  1387.     Iterates through (position, value) tuples of OrderedSet <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>.
    1388. 

  1388. <p><strong class="examples_text">Example:</strong></p>
    1389. 

  1389. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">toOrderedSet</span><span class="Punctuation">(</span><span class="StringLit">&quot;abracadabra&quot;</span><span class="Punctuation">)</span>
    1390. 

  1390. <span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">)</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    1391. 

  1391. <span class="Keyword">for</span> <span class="Identifier">x</span> <span class="Keyword">in</span> <span class="Identifier">pairs</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1392. 

  1392.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span>
    1393. 

  1393. <span class="Identifier">assert</span> <span class="Identifier">p</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="CharLit">'a'</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="CharLit">'b'</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="CharLit">'r'</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="CharLit">'c'</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="CharLit">'d'</span><span class="Punctuation">)</span><span class="Punctuation">]</span></pre>
    1394. 

  1394.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/collections/sets.nim#L918" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1395. 

  1395. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/collections/sets.nim#L918" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1396. 

  1396. 

  1397.   </dd>
    1398. 

  1398. </div>
    1399. 

  1399. 

  1400. </div>
    1401. 

  1401. 

  1402.   </dl>
    1403. 

  1403. </div>
    1404. 

  1404. 

  1405.   </div>
    1406. 

  1406. </div>
    1407. 

  1407. 

  1408.       <div class="twelve-columns footer">
    1409. 

  1409.         <span class="nim-sprite"></span>
    1410. 

  1410.         <br>
    1411. 

  1411.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:17 UTC</small>
    1412. 

  1412.       </div>
    1413. 

  1413.     </div>
    1414. 

  1414.   </div>
    1415. 

  1415.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1416. 

  1416.     
    1417. 

  1417. </body>
    1418. 

  1418. </html>
    1419. 

  1419.