<!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="CamomileLibrary.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="CamomileLibrary" rel="Chapter" href="CamomileLibrary.html"> <link title="CamomileLibraryDefault" rel="Chapter" href="CamomileLibraryDefault.html"> <link title="CamomileLibraryDyn" rel="Chapter" href="CamomileLibraryDyn.html"><title>CamomileLibrary.Type.UCol.Type</title> </head> <body> <div class="navbar"> <a class="up" href="CamomileLibrary.Type.UCol.html" title="CamomileLibrary.Type.UCol">Up</a> </div> <h1>Module type <a href="type_CamomileLibrary.Type.UCol.Type.html">CamomileLibrary.Type.UCol.Type</a></h1> <pre><span class="keyword">module type</span> Type = <code class="type"><a href="CamomileLibrary.UCol.Type.html">CamomileLibrary.UCol.Type</a></code></pre><hr width="100%"> <pre><span id="TYPEtext"><span class="keyword">type</span> <code class="type"></code>text</span> </pre> <pre><span id="TYPEindex"><span class="keyword">type</span> <code class="type"></code>index</span> </pre> <pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">?locale:string -><br> ?prec:<a href="CamomileLibrary.UCol.html#TYPEprecision">CamomileLibrary.UCol.precision</a> -><br> ?variable:<a href="CamomileLibrary.UCol.html#TYPEvariable_option">CamomileLibrary.UCol.variable_option</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -> int</code></pre><div class="info "> For locale, see <a href="CamomileLibrary.Locale.html"><code class="code">CamomileLibrary.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 id="VALsort_key"><span class="keyword">val</span> sort_key</span> : <code class="type">?locale:string -><br> ?prec:<a href="CamomileLibrary.UCol.html#TYPEprecision">CamomileLibrary.UCol.precision</a> -><br> ?variable:<a href="CamomileLibrary.UCol.html#TYPEvariable_option">CamomileLibrary.UCol.variable_option</a> -><br> <a href="CamomileLibrary.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 id="VALcompare_with_key"><span class="keyword">val</span> compare_with_key</span> : <code class="type">?locale:string -><br> ?prec:<a href="CamomileLibrary.UCol.html#TYPEprecision">CamomileLibrary.UCol.precision</a> -><br> ?variable:<a href="CamomileLibrary.UCol.html#TYPEvariable_option">CamomileLibrary.UCol.variable_option</a> -><br> string -> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -> int</code></pre><div class="info "> Comparison with the sort key.<br> </div> <pre><span id="VALsearch_with_key"><span class="keyword">val</span> search_with_key</span> : <code class="type">?locale:string -><br> ?prec:<a href="CamomileLibrary.UCol.html#TYPEprecision">CamomileLibrary.UCol.precision</a> -><br> ?variable:<a href="CamomileLibrary.UCol.html#TYPEvariable_option">CamomileLibrary.UCol.variable_option</a> -><br> string -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a> * <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a></code></pre> <pre><span id="VALsearch"><span class="keyword">val</span> search</span> : <code class="type">?locale:string -><br> ?prec:<a href="CamomileLibrary.UCol.html#TYPEprecision">CamomileLibrary.UCol.precision</a> -><br> ?variable:<a href="CamomileLibrary.UCol.html#TYPEvariable_option">CamomileLibrary.UCol.variable_option</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEtext">text</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a> -><br> <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a> * <a href="CamomileLibrary.UCol.Type.html#TYPEindex">index</a></code></pre></body></html>