<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="Main.Type.UCol.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of class methods" rel=Appendix href="index_methods.html"> <link title="Index of classes" rel=Appendix href="index_classes.html"> <link title="Index of class types" rel=Appendix href="index_class_types.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="CaseMap" rel="Chapter" href="CaseMap.html"> <link title="CharEncoding" rel="Chapter" href="CharEncoding.html"> <link title="Default" rel="Chapter" href="Default.html"> <link title="IMap" rel="Chapter" href="IMap.html"> <link title="ISet" rel="Chapter" href="ISet.html"> <link title="Locale" rel="Chapter" href="Locale.html"> <link title="Main" rel="Chapter" href="Main.html"> <link title="OOChannel" rel="Chapter" href="OOChannel.html"> <link title="SubText" rel="Chapter" href="SubText.html"> <link title="UCS4" rel="Chapter" href="UCS4.html"> <link title="UChar" rel="Chapter" href="UChar.html"> <link title="UCharInfo" rel="Chapter" href="UCharInfo.html"> <link title="UCharTbl" rel="Chapter" href="UCharTbl.html"> <link title="UCol" rel="Chapter" href="UCol.html"> <link title="ULine" rel="Chapter" href="ULine.html"> <link title="UMap" rel="Chapter" href="UMap.html"> <link title="UNF" rel="Chapter" href="UNF.html"> <link title="UPervasives" rel="Chapter" href="UPervasives.html"> <link title="URe" rel="Chapter" href="URe.html"> <link title="UReStr" rel="Chapter" href="UReStr.html"> <link title="USet" rel="Chapter" href="USet.html"> <link title="UTF16" rel="Chapter" href="UTF16.html"> <link title="UTF8" rel="Chapter" href="UTF8.html"> <link title="UText" rel="Chapter" href="UText.html"> <link title="UnicodeString" rel="Chapter" href="UnicodeString.html"> <link title="XArray" rel="Chapter" href="XArray.html"> <link title="XString" rel="Chapter" href="XString.html"><title>Main.Type.UCol.Type</title> </head> <body> <div class="navbar"> <a href="Main.Type.UCol.html">Up</a> </div> <center><h1>Module type <a href="type_Main.Type.UCol.Type.html">Main.Type.UCol.Type</a></h1></center> <br> <pre><span class="keyword">module type</span> Type = <code class="type"><a href="UCol.Type.html">UCol.Type</a></code></pre><hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEtext"></a><code class="type"></code>text </pre> <pre><span class="keyword">type</span> <a name="TYPEindex"></a><code class="type"></code>index </pre> <pre><span class="keyword">val</span> <a name="VALcompare"></a>compare : <code class="type">?locale:string -><br> ?prec:<a href="UCol.html#TYPEprecision">UCol.precision</a> -><br> ?variable:<a href="UCol.html#TYPEvariable_option">UCol.variable_option</a> -> <a href="UCol.Type.html#TYPEtext">text</a> -> <a href="UCol.Type.html#TYPEtext">text</a> -> int</code></pre><div class="info"> For locale, see <a href="Locale.html"><code class="code">Locale</code></a>. If <code class="code">locale</code> is omitted, the standard UCA order is used. If <code class="code">prec</code> is omitted, the maximum possible strength is used. If <code class="code">variable</code> is omitted, the default of the locale (usually <code class="code">`Shifted</code>) is used. The meaning of the returned value is similar to Pervasives.compare<br> </div> <pre><span class="keyword">val</span> <a name="VALsort_key"></a>sort_key : <code class="type">?locale:string -><br> ?prec:<a href="UCol.html#TYPEprecision">UCol.precision</a> -><br> ?variable:<a href="UCol.html#TYPEvariable_option">UCol.variable_option</a> -> <a href="UCol.Type.html#TYPEtext">text</a> -> string</code></pre><div class="info"> Binary comparison of sort_key gives the same result as <code class="code">compare</code>. i.e. <code class="code">compare t1 t2 = Pervasives.compare (sort_key t1) (sort_key t2)</code> If the same texts are repeatedly compared, pre-computation of sort_key gives better performance.<br> </div> <pre><span class="keyword">val</span> <a name="VALcompare_with_key"></a>compare_with_key : <code class="type">?locale:string -><br> ?prec:<a href="UCol.html#TYPEprecision">UCol.precision</a> -><br> ?variable:<a href="UCol.html#TYPEvariable_option">UCol.variable_option</a> -> string -> <a href="UCol.Type.html#TYPEtext">text</a> -> int</code></pre><div class="info"> Comparison with the sort key.<br> </div> <pre><span class="keyword">val</span> <a name="VALsearch_with_key"></a>search_with_key : <code class="type">?locale:string -><br> ?prec:<a href="UCol.html#TYPEprecision">UCol.precision</a> -><br> ?variable:<a href="UCol.html#TYPEvariable_option">UCol.variable_option</a> -><br> string -><br> <a href="UCol.Type.html#TYPEtext">text</a> -> <a href="UCol.Type.html#TYPEindex">index</a> -> <a href="UCol.Type.html#TYPEindex">index</a> * <a href="UCol.Type.html#TYPEindex">index</a></code></pre><pre><span class="keyword">val</span> <a name="VALsearch"></a>search : <code class="type">?locale:string -><br> ?prec:<a href="UCol.html#TYPEprecision">UCol.precision</a> -><br> ?variable:<a href="UCol.html#TYPEvariable_option">UCol.variable_option</a> -><br> <a href="UCol.Type.html#TYPEtext">text</a> -><br> <a href="UCol.Type.html#TYPEtext">text</a> -> <a href="UCol.Type.html#TYPEindex">index</a> -> <a href="UCol.Type.html#TYPEindex">index</a> * <a href="UCol.Type.html#TYPEindex">index</a></code></pre></body></html>