docs/api/Belt_MutableSet.String.html

<!doctype html>
<html>
<head>
                 <link rel="stylesheet" href="../api_static/tomorrow-night.css">
                 <link rel="stylesheet" href="../api_static/style.css" type="text/css">
                 <script src="../api_static//highlight.pack.js"></script>
                 <script src="../api_static//script.js"></script>
                 <script>hljs.initHighlightingOnLoad();</script> 
                 <meta charset="utf8">
                 <link rel="previous" href="Belt_MutableSet.Int.html">
                 <title> Belt_MutableSet.String </title></head> 
               <body>
<nav class="module-index"><ul><li><a href="Belt.html">Belt</a></li>
<li><a href="Belt_Array.html">Belt_Array</a></li>
<li><a href="Belt_Debug.html">Belt_Debug</a></li>
<li><a href="Belt_Float.html">Belt_Float</a></li>
<li><a href="Belt_HashMap.html">Belt_HashMap</a></li>
<li><a href="Belt_HashMapInt.html">Belt_HashMapInt</a></li>
<li><a href="Belt_HashMapString.html">Belt_HashMapString</a></li>
<li><a href="Belt_HashSet.html">Belt_HashSet</a></li>
<li><a href="Belt_HashSetInt.html">Belt_HashSetInt</a></li>
<li><a href="Belt_HashSetString.html">Belt_HashSetString</a></li>
<li><a href="Belt_Id.html">Belt_Id</a></li>
<li><a href="Belt_Int.html">Belt_Int</a></li>
<li><a href="Belt_List.html">Belt_List</a></li>
<li><a href="Belt_Map.html">Belt_Map</a></li>
<li><a href="Belt_MapDict.html">Belt_MapDict</a></li>
<li><a href="Belt_MapInt.html">Belt_MapInt</a></li>
<li><a href="Belt_MapString.html">Belt_MapString</a></li>
<li><a href="Belt_MutableMap.html">Belt_MutableMap</a></li>
<li><a href="Belt_MutableMapInt.html">Belt_MutableMapInt</a></li>
<li><a href="Belt_MutableMapString.html">Belt_MutableMapString</a></li>
<li><a href="Belt_MutableQueue.html">Belt_MutableQueue</a></li>
<li><a href="Belt_MutableSet.html">Belt_MutableSet</a></li>
<li><a href="Belt_MutableSetInt.html">Belt_MutableSetInt</a></li>
<li><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></li>
<li><a href="Belt_MutableStack.html">Belt_MutableStack</a></li>
<li><a href="Belt_Option.html">Belt_Option</a></li>
<li><a href="Belt_Range.html">Belt_Range</a></li>
<li><a href="Belt_Result.html">Belt_Result</a></li>
<li><a href="Belt_Set.html">Belt_Set</a></li>
<li><a href="Belt_SetDict.html">Belt_SetDict</a></li>
<li><a href="Belt_SetInt.html">Belt_SetInt</a></li>
<li><a href="Belt_SetString.html">Belt_SetString</a></li>
<li><a href="Belt_SortArray.html">Belt_SortArray</a></li>
<li><a href="Belt_SortArrayInt.html">Belt_SortArrayInt</a></li>
<li><a href="Belt_SortArrayString.html">Belt_SortArrayString</a></li>
<li><a href="Belt_internalAVLset.html">Belt_internalAVLset</a></li>
<li><a href="Belt_internalAVLtree.html">Belt_internalAVLtree</a></li>
<li><a href="Belt_internalBuckets.html">Belt_internalBuckets</a></li>
<li><a href="Belt_internalBucketsType.html">Belt_internalBucketsType</a></li>
<li><a href="Belt_internalMapInt.html">Belt_internalMapInt</a></li>
<li><a href="Belt_internalMapString.html">Belt_internalMapString</a></li>
<li><a href="Belt_internalSetBuckets.html">Belt_internalSetBuckets</a></li>
<li><a href="Belt_internalSetInt.html">Belt_internalSetInt</a></li>
<li><a href="Belt_internalSetString.html">Belt_internalSetString</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Dom_storage.html">Dom_storage</a></li>
<li><a href="Dom_storage2.html">Dom_storage2</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_array2.html">Js_array2</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_console.html">Js_console</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_list.html">Js_list</a></li>
<li><a href="Js_mapperRt.html">Js_mapperRt</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_option.html">Js_option</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_result.html">Js_result</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_string2.html">Js_string2</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_typed_array2.html">Js_typed_array2</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_vector.html">Js_vector</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"><a class="pre" href="Belt_MutableSet.Int.html" title="Belt_MutableSet.Int">Previous</a>
&nbsp;<a class="up" href="Belt_MutableSet.html" title="Belt_MutableSet">Up</a>
&nbsp;</div>
<h1>Module <a href="type_Belt_MutableSet.String.html">Belt_MutableSet.String</a></h1>

<pre><span id="MODULEString"><span class="keyword">module</span> String</span>: <code class="type"><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></code></pre><div class="info module top">
                    <div class="not-examples">
                    Specalized when key type is <code class="code">string</code>, more efficient
    than the generic type<br>
 
                    </div>
                    
                    </div>

                  <hr width="100%">

<pre><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> = <code class="type">string</code> </pre>
<div class="info ">
                    <div class="not-examples">
                    The type of the set elements.<br>
 
                    </div>
                    
                    </div>

                  

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
                    <div class="not-examples">
                    The type of sets.<br>
 
                    </div>
                    
                    </div>

                  

<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">unit -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALfromArray"><span class="keyword">val</span> fromArray</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEvalue">value</a> array -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALfromSortedArrayUnsafe"><span class="keyword">val</span> fromSortedArrayUnsafe</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEvalue">value</a> array -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALhas"><span class="keyword">val</span> has</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool</code></pre>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> unit</code></pre>
<pre><span id="VALaddCheck"><span class="keyword">val</span> addCheck</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool</code></pre>
<pre><span id="VALmergeMany"><span class="keyword">val</span> mergeMany</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> array -> unit</code></pre>
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> unit</code></pre>
<pre><span id="VALremoveCheck"><span class="keyword">val</span> removeCheck</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool</code></pre>
<pre><span id="VALremoveMany"><span class="keyword">val</span> removeMany</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> array -> unit</code></pre>
<pre><span id="VALunion"><span class="keyword">val</span> union</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALintersect"><span class="keyword">val</span> intersect</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALdiff"><span class="keyword">val</span> diff</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALsubset"><span class="keyword">val</span> subset</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALcmp"><span class="keyword">val</span> cmp</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALeq"><span class="keyword">val</span> eq</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALforEachU"><span class="keyword">val</span> forEachU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> unit [@bs]) -> unit</code></pre>
<pre><span id="VALforEach"><span class="keyword">val</span> forEach</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> unit) -> unit</code></pre><div class="info ">
                    <div class="not-examples">
                    In increasing order<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALreduceU"><span class="keyword">val</span> reduceU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       'a -> ('a -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> 'a [@bs]) -> 'a</code></pre>
<pre><span id="VALreduce"><span class="keyword">val</span> reduce</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       'a -> ('a -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> 'a) -> 'a</code></pre><div class="info ">
                    <div class="not-examples">
                    Iterate in increasing order.<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALeveryU"><span class="keyword">val</span> everyU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool [@bs]) -> bool</code></pre>
<pre><span id="VALevery"><span class="keyword">val</span> every</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool) -> bool</code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">every p s</code> checks if all elements of the set
    satisfy the predicate <code class="code">p</code>. Order unspecified.<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool [@bs]) -> bool</code></pre>
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool) -> bool</code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">some p s</code> checks if at least one element of
    the set satisfies the predicate <code class="code">p</code>. Oder unspecified.<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALkeepU"><span class="keyword">val</span> keepU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool [@bs]) -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALkeep"><span class="keyword">val</span> keep</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool) -> <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">keep s p</code> returns a fresh copy of the set of all elements in <code class="code">s</code>
    that satisfy predicate <code class="code">p</code>.<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALpartitionU"><span class="keyword">val</span> partitionU</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool [@bs]) -><br>       <a href="Belt_MutableSetString.html#TYPEt">t</a> * <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre>
<pre><span id="VALpartition"><span class="keyword">val</span> partition</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> bool) -><br>       <a href="Belt_MutableSetString.html#TYPEt">t</a> * <a href="Belt_MutableSetString.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">partition s p</code> returns a fresh copy pair of sets <code class="code">(s1, s2)</code>, where
    <code class="code">s1</code> is the set of all the elements of <code class="code">s</code> that satisfy the
    predicate <code class="code">p</code>, and <code class="code">s2</code> is the set of all the elements of
    <code class="code">s</code> that do not satisfy <code class="code">p</code>.<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALtoList"><span class="keyword">val</span> toList</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> list</code></pre><div class="info ">
                    <div class="not-examples">
                    In increasing order with respect<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALtoArray"><span class="keyword">val</span> toArray</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> array</code></pre>
<pre><span id="VALminimum"><span class="keyword">val</span> minimum</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> option</code></pre>
<pre><span id="VALminUndefined"><span class="keyword">val</span> minUndefined</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
<pre><span id="VALmaximum"><span class="keyword">val</span> maximum</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> option</code></pre>
<pre><span id="VALmaxUndefined"><span class="keyword">val</span> maxUndefined</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> option</code></pre>
<pre><span id="VALgetUndefined"><span class="keyword">val</span> getUndefined</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a> <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
<pre><span id="VALgetExn"><span class="keyword">val</span> getExn</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -> <a href="Belt_MutableSetString.html#TYPEvalue">value</a></code></pre>
<pre><span id="VALsplit"><span class="keyword">val</span> split</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -><br>       <a href="Belt_MutableSetString.html#TYPEvalue">value</a> -><br>       (<a href="Belt_MutableSetString.html#TYPEt">t</a> * <a href="Belt_MutableSetString.html#TYPEt">t</a>) * bool</code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">split s key</code> return a fresh copy of each<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALcheckInvariantInternal"><span class="keyword">val</span> checkInvariantInternal</span> : <code class="type"><a href="Belt_MutableSetString.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
                    <div class="not-examples">
                    <b>raise</b> when invariant is not held<br>
 
                    </div>
                    
                    </div>

                  </body></html>