ceph/src/boost/libs/locale/doc/html/structboost_1_1locale_1_1comparator.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.6"/>
   7 <title>Boost.Locale: boost::locale::comparator&lt; CharType, default_level &gt; Struct Template Reference</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16   $(window).load(resizeHeight);
  17 </script>
  18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19 </head>
  20 <body>
  21 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22 <div id="titlearea">
  23 <table cellspacing="0" cellpadding="0">
  24  <tbody>
  25  <tr style="height: 56px;">
  26   <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27   <td style="padding-left: 0.5em;">
  28    <div id="projectname">Boost.Locale
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.6 -->
  37   <div id="navrow1" class="tabs">
  38     <ul class="tablist">
  39       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41       <li><a href="modules.html"><span>Modules</span></a></li>
  42       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44       <li><a href="files.html"><span>Files</span></a></li>
  45       <li><a href="examples.html"><span>Examples</span></a></li>
  46     </ul>
  47   </div>
  48   <div id="navrow2" class="tabs2">
  49     <ul class="tablist">
  50       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53     </ul>
  54   </div>
  55 </div><!-- top -->
  56 <div id="side-nav" class="ui-resizable side-nav-resizable">
  57   <div id="nav-tree">
  58     <div id="nav-tree-contents">
  59       <div id="nav-sync" class="sync"></div>
  60     </div>
  61   </div>
  62   <div id="splitbar" style="-moz-user-select:none;"
  63        class="ui-resizable-handle">
  64   </div>
  65 </div>
  66 <script type="text/javascript">
  67 $(document).ready(function(){initNavTree('structboost_1_1locale_1_1comparator.html','');});
  68 </script>
  69 <div id="doc-content">
  70 <div class="header">
  71   <div class="summary">
  72 <a href="#pub-methods">Public Member Functions</a> &#124;
  73 <a href="structboost_1_1locale_1_1comparator-members.html">List of all members</a>  </div>
  74   <div class="headertitle">
  75 <div class="title">boost::locale::comparator&lt; CharType, default_level &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__collation.html">Collation</a></div></div>  </div>
  76 </div><!--header-->
  77 <div class="contents">
  78
  79 <p>This class can be used in STL algorithms and containers for comparison of strings with a level other than primary.
  80  <a href="structboost_1_1locale_1_1comparator.html#details">More...</a></p>
  81
  82 <p><code>#include &lt;<a class="el" href="collator_8hpp_source.html">boost/locale/collator.hpp</a>&gt;</code></p>
  83 <table class="memberdecls">
  84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85 Public Member Functions</h2></td></tr>
  86 <tr class="memitem:af40ee48c6c93b6e5d91492a3e0cb96a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1comparator.html#af40ee48c6c93b6e5d91492a3e0cb96a8">comparator</a> (std::locale const &amp;l=std::locale(), <a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">collator_base::level_type</a> level=default_level)</td></tr>
  87 <tr class="separator:af40ee48c6c93b6e5d91492a3e0cb96a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:abd62dbc2af0eb6e6c261a7c88e09f752"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1comparator.html#abd62dbc2af0eb6e6c261a7c88e09f752">operator()</a> (std::basic_string&lt; CharType &gt; const &amp;left, std::basic_string&lt; CharType &gt; const &amp;right) const </td></tr>
  89 <tr class="separator:abd62dbc2af0eb6e6c261a7c88e09f752"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 </table>
  91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92 <div class="textblock"><h3>template&lt;typename CharType, collator_base::level_type default_level = collator_base::identical&gt;<br/>
  93 struct boost::locale::comparator&lt; CharType, default_level &gt;</h3>
  94
  95 <p>This class can be used in STL algorithms and containers for comparison of strings with a level other than primary. </p>
  96 <p>For example:</p>
  97 <div class="fragment"><div class="line">std::map&lt;std::string,std::string,comparator&lt;char,collator_base::secondary&gt; &gt; data;</div>
  98 </div><!-- fragment --><p>Would create a map the keys of which are sorted using secondary collation level </p>
  99 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 100 <a class="anchor" id="af40ee48c6c93b6e5d91492a3e0cb96a8"></a>
 101 <div class="memitem">
 102 <div class="memproto">
 103 <div class="memtemplate">
 104 template&lt;typename CharType , collator_base::level_type default_level = collator_base::identical&gt; </div>
 105 <table class="mlabels">
 106   <tr>
 107   <td class="mlabels-left">
 108       <table class="memname">
 109         <tr>
 110           <td class="memname"><a class="el" href="structboost_1_1locale_1_1comparator.html">boost::locale::comparator</a>&lt; CharType, default_level &gt;::<a class="el" href="structboost_1_1locale_1_1comparator.html">comparator</a> </td>
 111           <td>(</td>
 112           <td class="paramtype">std::locale const &amp;&#160;</td>
 113           <td class="paramname"><em>l</em> = <code>std::locale()</code>, </td>
 114         </tr>
 115         <tr>
 116           <td class="paramkey"></td>
 117           <td></td>
 118           <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">collator_base::level_type</a>&#160;</td>
 119           <td class="paramname"><em>level</em> = <code>default_level</code>&#160;</td>
 120         </tr>
 121         <tr>
 122           <td></td>
 123           <td>)</td>
 124           <td></td><td></td>
 125         </tr>
 126       </table>
 127   </td>
 128   <td class="mlabels-right">
 129 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 130   </tr>
 131 </table>
 132 </div><div class="memdoc">
 133 <p>Create a comparator class for locale <em>l</em> and with collation leval <em>level</em> </p>
 134 <dl class="section note"><dt>Note</dt><dd>throws std::bad_cast if l does not have <a class="el" href="classboost_1_1locale_1_1collator.html">collator</a> facet installed </dd></dl>
 135
 136 </div>
 137 </div>
 138 <h2 class="groupheader">Member Function Documentation</h2>
 139 <a class="anchor" id="abd62dbc2af0eb6e6c261a7c88e09f752"></a>
 140 <div class="memitem">
 141 <div class="memproto">
 142 <div class="memtemplate">
 143 template&lt;typename CharType , collator_base::level_type default_level = collator_base::identical&gt; </div>
 144 <table class="mlabels">
 145   <tr>
 146   <td class="mlabels-left">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname">bool <a class="el" href="structboost_1_1locale_1_1comparator.html">boost::locale::comparator</a>&lt; CharType, default_level &gt;::operator() </td>
 150           <td>(</td>
 151           <td class="paramtype">std::basic_string&lt; CharType &gt; const &amp;&#160;</td>
 152           <td class="paramname"><em>left</em>, </td>
 153         </tr>
 154         <tr>
 155           <td class="paramkey"></td>
 156           <td></td>
 157           <td class="paramtype">std::basic_string&lt; CharType &gt; const &amp;&#160;</td>
 158           <td class="paramname"><em>right</em>&#160;</td>
 159         </tr>
 160         <tr>
 161           <td></td>
 162           <td>)</td>
 163           <td></td><td> const</td>
 164         </tr>
 165       </table>
 166   </td>
 167   <td class="mlabels-right">
 168 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 169   </tr>
 170 </table>
 171 </div><div class="memdoc">
 172 <p>Compare two strings &ndash; equivalent to return left &lt; right according to collation rules </p>
 173
 174 </div>
 175 </div>
 176 <hr/>The documentation for this struct was generated from the following file:<ul>
 177 <li>boost/locale/<a class="el" href="collator_8hpp_source.html">collator.hpp</a></li>
 178 </ul>
 179 </div><!-- contents -->
 180 </div><!-- doc-content -->
 181
 182     <li class="footer">
 183 &copy; Copyright 2009-2012 Artyom Beilis,  Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
 184     </li>
 185    </ul>
 186  </div>
 187 </body>
 188 </html>