docs/api/Belt_SortArray.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_SortArray.Int.html">
                 <title> Belt_SortArray.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_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_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_internalMutableAVLMap.html">Belt_internalMutableAVLMap</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="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</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_typed_array.html">Js_typed_array</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_SortArray.Int.html" title="Belt_SortArray.Int">Previous</a>
&nbsp;<a class="up" href="Belt_SortArray.html" title="Belt_SortArray">Up</a>
&nbsp;</div>
<h1>Module <a href="type_Belt_SortArray.String.html">Belt_SortArray.String</a></h1>

<pre><span class="keyword">module</span> String: <code class="type"><a href="Belt_SortArrayString.html">Belt_SortArrayString</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%">
<div class="type-declaration">
<pre><span id="TYPEelement"><span class="keyword">type</span> <code class="type"></code>element</span> = <code class="type">string</code> </pre>
</div>


<pre><span id="VALstrictlySortedLength"><span class="keyword">val</span> strictlySortedLength</span> : <code class="type"><a href="Belt_SortArrayString.html#TYPEelement">element</a> array -> int</code></pre><div class="info ">
                    <div class="not-examples">
                    The same as <a href="Belt_SortArray.html#VALstrictlySortedLength"><code class="code">Belt_SortArray.strictlySortedLength</code></a> except the comparator is fixed<br>
<div class="tag"> <b>Returns</b> <code class="code">+n</code> means increasing order  <code class="code">-n</code> means negative order<br>
 </div> 
                    </div>
                    
                    </div>

                  
<pre><span id="VALisSorted"><span class="keyword">val</span> isSorted</span> : <code class="type"><a href="Belt_SortArrayString.html#TYPEelement">element</a> array -> bool</code></pre><div class="info ">
                    <div class="not-examples">
                    <code class="code">sorted xs</code> return true if <code class="code">xs</code> is in non strict increasing order<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALstableSortInPlace"><span class="keyword">val</span> stableSortInPlace</span> : <code class="type"><a href="Belt_SortArrayString.html#TYPEelement">element</a> array -> unit</code></pre><div class="info ">
                    <div class="not-examples">
                    The same as <a href="Belt_SortArray.html#VALstableSortInPlaceBy"><code class="code">Belt_SortArray.stableSortInPlaceBy</code></a> except the comparator is fixed<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALstableSort"><span class="keyword">val</span> stableSort</span> : <code class="type"><a href="Belt_SortArrayString.html#TYPEelement">element</a> array -> <a href="Belt_SortArrayString.html#TYPEelement">element</a> array</code></pre><div class="info ">
                    <div class="not-examples">
                    The same as <a href="Belt_SortArray.html#VALstableSortBy"><code class="code">Belt_SortArray.stableSortBy</code></a> except the comparator is fixed<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALbinarySearch"><span class="keyword">val</span> binarySearch</span> : <code class="type"><a href="Belt_SortArrayString.html#TYPEelement">element</a> array -> <a href="Belt_SortArrayString.html#TYPEelement">element</a> -> int</code></pre><div class="info ">
                    <div class="not-examples">
                    If value is not found and value is less than one or more elements in array, 
  the negative number returned is the bitwise complement of the index of the first element 
  that is larger than value. 
<p>

  If value is not found and value is greater than all elements in array,
  the negative number returned is the bitwise complement of 
  (the index of the last element plus 1)
<p>

  for example, if <code class="code">key</code> is smaller than all elements return <code class="code">-1</code> since <code class="code">lnot (-1) = 0</code>
  if <code class="code">key</code> is larger than all elements return <code class="code">- (len + 1)</code> since <code class="code">lnot (-(len+1)) = len</code><br>
 
                    </div>
                    
                    </div>

                  </body></html>