setutils.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/setutils</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/setutils</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
  50. <li>
  51. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  52. </li>
  53. <li>
  54. <details open>
  55. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  56. <ul class="simple simple-toc-section">
  57. <ul class="simple nested-toc-section">-+-
  58. <li><a class="reference" href="#-%2B-%2Cset%5BT%5D%2Cset%5BT%5D" title="`-+-`[T](x, y: set[T]): set[T]">`-+-`[T](x, y: set[T]): set[T]</a></li>
  59. </ul>
  60. <ul class="simple nested-toc-section">[]=
  61. <li><a class="reference" href="#%5B%5D%3D%2Cset%5BT%5D%2CT%2Cbool" title="`[]=`[T](t: var set[T]; key: T; val: bool)">`[]=`[T](t: var set[T]; key: T; val: bool)</a></li>
  62. </ul>
  63. <ul class="simple nested-toc-section">complement
  64. <li><a class="reference" href="#complement%2Cset%5BT%5D" title="complement[T](s: set[T]): set[T]">complement[T](s: set[T]): set[T]</a></li>
  65. </ul>
  66. <ul class="simple nested-toc-section">fullSet
  67. <li><a class="reference" href="#fullSet%2Ctypedesc%5BT%5D" title="fullSet[T](U: typedesc[T]): set[T]">fullSet[T](U: typedesc[T]): set[T]</a></li>
  68. </ul>
  69. <ul class="simple nested-toc-section">symmetricDifference
  70. <li><a class="reference" href="#symmetricDifference%2Cset%5BT%5D%2Cset%5BT%5D" title="symmetricDifference[T](x, y: set[T]): set[T]">symmetricDifference[T](x, y: set[T]): set[T]</a></li>
  71. </ul>
  72. <ul class="simple nested-toc-section">toggle
  73. <li><a class="reference" href="#toggle%2Cset%5BT%5D%2Cset%5BT%5D" title="toggle[T](x: var set[T]; y: set[T])">toggle[T](x: var set[T]; y: set[T])</a></li>
  74. </ul>
  75. </ul>
  76. </details>
  77. </li>
  78. <li>
  79. <details open>
  80. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  81. <ul class="simple simple-toc-section">
  82. <ul class="simple nested-toc-section">toSet
  83. <li><a class="reference" href="#toSet.t%2Cuntyped" title="toSet(iter: untyped): untyped">toSet(iter: untyped): untyped</a></li>
  84. </ul>
  85. </ul>
  86. </details>
  87. </li>
  88. </ul>
  89. </div>
  90. <div class="nine columns" id="content">
  91. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  92. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  93. <div id="tocRoot"></div>
  94. <p class="module-desc">This module adds functionality for the built-in <tt class="docutils literal"><span class="pre"><span class="Identifier">set</span></span></tt> type.
  95. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="packedsets.html">std/packedsets</a></li>
  96. <li><a class="reference external" href="sets.html">std/sets</a></li>
  97. </ul>
  98. </p>
  99. <div class="section" id="6">
  100. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  101. <dl class="item">
  102. <a class="reference external" href="typetraits.html">typetraits</a>, <a class="reference external" href="macros.html">macros</a>
  103. </dl>
  104. </div>
  105. <div class="section" id="12">
  106. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  107. <dl class="item">
  108. <div id="-+--procs-all">
  109. <div id="-+-,set[T],set[T]">
  110. <dt><pre><span class="Keyword">proc</span> <a href="#-%2B-%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`-+-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
  111. <dd>
  112. Operator alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">symmetricDifference</span></span></tt>.
  113. <p><strong class="examples_text">Example:</strong></p>
  114. <pre class="listing"><span class="Identifier">assert</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="Operator">-+-</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="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span></pre>
  115. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L90" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  116. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L90" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  117. </dd>
  118. </div>
  119. </div>
  120. <div id="[]=-procs-all">
  121. <div id="[]=,set[T],T,bool">
  122. <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%3D%2Cset%5BT%5D%2CT%2Cbool"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">key</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span>.}</pre></dt>
  123. <dd>
  124. Syntax sugar for <tt class="docutils literal"><span class="pre"><span class="Keyword">if</span> <span class="Identifier">val</span><span class="Punctuation">:</span> <span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">incl</span> <span class="Identifier">key</span> <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">excl</span> <span class="Identifier">key</span></span></tt>
  125. <p><strong class="examples_text">Example:</strong></p>
  126. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">A</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
  127. <span class="Identifier">a0</span><span class="Punctuation">,</span> <span class="Identifier">a1</span><span class="Punctuation">,</span> <span class="Identifier">a2</span><span class="Punctuation">,</span> <span class="Identifier">a3</span>
  128. <span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Identifier">a0</span><span class="Punctuation">,</span> <span class="Identifier">a3</span><span class="Punctuation">}</span>
  129. <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">a0</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Identifier">false</span>
  130. <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">a1</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Identifier">false</span>
  131. <span class="Identifier">assert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">a3</span><span class="Punctuation">}</span>
  132. <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">a2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Identifier">true</span>
  133. <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">a3</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Identifier">true</span>
  134. <span class="Identifier">assert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">a2</span><span class="Punctuation">,</span> <span class="Identifier">a3</span><span class="Punctuation">}</span></pre>
  135. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L65" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  136. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L65" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  137. </dd>
  138. </div>
  139. </div>
  140. <div id="complement-procs-all">
  141. <div id="complement,set[T]">
  142. <dt><pre><span class="Keyword">func</span> <a href="#complement%2Cset%5BT%5D"><span class="Identifier">complement</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
  143. <dd>
  144. Returns the set complement of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
  145. <p><strong class="examples_text">Example:</strong></p>
  146. <pre class="listing"><span class="Keyword">type</span> <span class="Identifier">Colors</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
  147. <span class="Identifier">red</span><span class="Punctuation">,</span> <span class="Identifier">green</span> <span class="Operator">=</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">blue</span>
  148. <span class="Identifier">assert</span> <span class="Identifier">complement</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="Identifier">red</span><span class="Punctuation">,</span> <span class="Identifier">blue</span><span class="Punctuation">}</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">green</span><span class="Punctuation">}</span>
  149. <span class="Identifier">assert</span> <span class="Identifier">complement</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="Identifier">red</span><span class="Punctuation">,</span> <span class="Identifier">green</span><span class="Punctuation">,</span> <span class="Identifier">blue</span><span class="Punctuation">}</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">card</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
  150. <span class="Identifier">assert</span> <span class="Identifier">complement</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">10</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">0</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> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">10</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="DecNumber">5</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="DecNumber">8</span><span class="Punctuation">,</span> <span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">}</span>
  151. <span class="Identifier">assert</span> <span class="Identifier">complement</span><span class="Punctuation">(</span><span class="Punctuation">{</span><span class="Punctuation">'</span><span class="DecNumber">0'</span><span class="Operator">..</span><span class="CharLit">'9'</span><span class="Punctuation">}</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="FloatNumber">0.</span><span class="Identifier">char</span><span class="Operator">..</span><span class="FloatNumber">255.</span><span class="Identifier">char</span><span class="Punctuation">}</span> <span class="Operator">-</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="DecNumber">0'</span><span class="Operator">..</span><span class="CharLit">'9'</span><span class="Punctuation">}</span></pre>
  152. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L54" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  153. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L54" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  154. </dd>
  155. </div>
  156. </div>
  157. <div id="fullSet-procs-all">
  158. <div id="fullSet,typedesc[T]">
  159. <dt><pre><span class="Keyword">func</span> <a href="#fullSet%2Ctypedesc%5BT%5D"><span class="Identifier">fullSet</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">U</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">inline</span>.}</pre></dt>
  160. <dd>
  161. Returns a set containing all elements in <tt class="docutils literal"><span class="pre"><span class="Identifier">U</span></span></tt>.
  162. <p><strong class="examples_text">Example:</strong></p>
  163. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">bool</span><span class="Operator">.</span><span class="Identifier">fullSet</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">true</span><span class="Punctuation">,</span> <span class="Identifier">false</span><span class="Punctuation">}</span>
  164. <span class="Keyword">type</span> <span class="Identifier">A</span> <span class="Operator">=</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">]</span>
  165. <span class="Identifier">assert</span> <span class="Identifier">A</span><span class="Operator">.</span><span class="Identifier">fullSet</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="FloatNumber">1.</span><span class="Identifier">A</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span>
  166. <span class="Identifier">assert</span> <span class="Identifier">int8</span><span class="Operator">.</span><span class="Identifier">fullSet</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">256</span></pre>
  167. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L42" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  168. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L42" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  169. </dd>
  170. </div>
  171. </div>
  172. <div id="symmetricDifference-procs-all">
  173. <div id="symmetricDifference,set[T],set[T]">
  174. <dt><pre><span class="Keyword">func</span> <a href="#symmetricDifference%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">symmetricDifference</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;XorSet&quot;</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  175. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  176. <dd>
  177. This operator computes the symmetric difference of two sets, equivalent to but more efficient than <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">+</span> <span class="Identifier">y</span> <span class="Operator">-</span> <span class="Identifier">x</span> <span class="Operator">*</span> <span class="Identifier">y</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Operator">-</span> <span class="Identifier">y</span><span class="Punctuation">)</span> <span class="Operator">+</span> <span class="Punctuation">(</span><span class="Identifier">y</span> <span class="Operator">-</span> <span class="Identifier">x</span><span class="Punctuation">)</span></span></tt>.
  178. <p><strong class="examples_text">Example:</strong></p>
  179. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">symmetricDifference</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> <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="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span></pre>
  180. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L80" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  181. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L80" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  182. </dd>
  183. </div>
  184. </div>
  185. <div id="toggle-procs-all">
  186. <div id="toggle,set[T],set[T]">
  187. <dt><pre><span class="Keyword">proc</span> <a href="#toggle%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">toggle</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">inline</span>.}</pre></dt>
  188. <dd>
  189. Toggles the existence of each value of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. If any element in <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> is also in <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, it is excluded from <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>; otherwise it is included. Equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">symmetricDifference</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
  190. <p><strong class="examples_text">Example:</strong></p>
  191. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</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>
  192. <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">toggle</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">4</span><span class="Punctuation">}</span><span class="Punctuation">)</span>
  193. <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span></pre>
  194. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L96" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  195. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L96" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  196. </dd>
  197. </div>
  198. </div>
  199. </dl>
  200. </div>
  201. <div class="section" id="18">
  202. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  203. <dl class="item">
  204. <div id="toSet-templates-all">
  205. <div id="toSet.t,untyped">
  206. <dt><pre><span class="Keyword">template</span> <a href="#toSet.t%2Cuntyped"><span class="Identifier">toSet</span></a><span class="Other">(</span><span class="Identifier">iter</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
  207. <dd>
  208. Returns a built-in set from the elements of the iterable <tt class="docutils literal"><span class="pre"><span class="Identifier">iter</span></span></tt>.
  209. <p><strong class="examples_text">Example:</strong></p>
  210. <pre class="listing"><span class="Identifier">assert</span> <span class="StringLit">&quot;helloWorld&quot;</span><span class="Operator">.</span><span class="Identifier">toSet</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">W</span><span class="CharLit">', '</span><span class="Identifier">d</span><span class="CharLit">', '</span><span class="Identifier">e</span><span class="CharLit">', '</span><span class="Identifier">h</span><span class="CharLit">', '</span><span class="Identifier">l</span><span class="CharLit">', '</span><span class="Identifier">o</span><span class="CharLit">', '</span><span class="Identifier">r</span><span class="CharLit">'}</span>
  211. <span class="Identifier">assert</span> <span class="Identifier">toSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Identifier">u16</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">10</span><span class="Identifier">u16</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">}</span>
  212. <span class="Identifier">assert</span> <span class="Punctuation">[</span><span class="DecNumber">30</span><span class="Identifier">u8</span><span class="Punctuation">,</span> <span class="DecNumber">100</span><span class="Punctuation">,</span> <span class="DecNumber">10</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toSet</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">10</span><span class="Identifier">u8</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">,</span> <span class="DecNumber">100</span><span class="Punctuation">}</span>
  213. <span class="Identifier">assert</span> <span class="Identifier">toSet</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1321</span><span class="Identifier">i16</span><span class="Punctuation">,</span> <span class="DecNumber">321</span><span class="Punctuation">,</span> <span class="DecNumber">90</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">90</span><span class="Identifier">i16</span><span class="Punctuation">,</span> <span class="DecNumber">321</span><span class="Punctuation">,</span> <span class="DecNumber">1321</span><span class="Punctuation">}</span>
  214. <span class="Identifier">assert</span> <span class="Identifier">toSet</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="Identifier">false</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="Identifier">false</span><span class="Punctuation">}</span>
  215. <span class="Identifier">assert</span> <span class="Identifier">toSet</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Identifier">u8</span><span class="Operator">..</span><span class="DecNumber">10</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">0</span><span class="Identifier">u8</span><span class="Operator">..</span><span class="DecNumber">10</span><span class="Punctuation">}</span></pre>
  216. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/setutils.nim#L24" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  217. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/setutils.nim#L24" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  218. </dd>
  219. </div>
  220. </div>
  221. </dl>
  222. </div>
  223. </div>
  224. </div>
  225. <div class="twelve-columns footer">
  226. <span class="nim-sprite"></span>
  227. <br>
  228. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:46 UTC</small>
  229. </div>
  230. </div>
  231. </div>
  232. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  233. </body>
  234. </html>