libs/geometry/doc/index/html_by_doxygen/structboost_1_1geometry_1_1index_1_1equal__to.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.Geometry.Index: boost::geometry::index::equal_to&lt; Value &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="search/search.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="search/search.js"></script>
  13 <script type="text/javascript">
  14   $(document).ready(function() { searchBox.OnSelectItem(0); });
  15 </script>
  16 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td style="padding-left: 0.5em;">
  25    <div id="projectname">Boost.Geometry.Index
  26    </div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.6 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  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="modules.html"><span>Modules</span></a></li>
  41       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42       <li><a href="files.html"><span>Files</span></a></li>
  43       <li>
  44         <div id="MSearchBox" class="MSearchBoxInactive">
  45         <span class="left">
  46           <img id="MSearchSelect" src="search/mag_sel.png"
  47                onmouseover="return searchBox.OnSearchSelectShow()"
  48                onmouseout="return searchBox.OnSearchSelectHide()"
  49                alt=""/>
  50           <input type="text" id="MSearchField" value="Search" accesskey="S"
  51                onfocus="searchBox.OnSearchFieldFocus(true)"
  52                onblur="searchBox.OnSearchFieldFocus(false)"
  53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54           </span><span class="right">
  55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56           </span>
  57         </div>
  58       </li>
  59     </ul>
  60   </div>
  61   <div id="navrow2" class="tabs2">
  62     <ul class="tablist">
  63       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  65       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  66       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  67     </ul>
  68   </div>
  69 <!-- window showing the filter options -->
  70 <div id="MSearchSelectWindow"
  71      onmouseover="return searchBox.OnSearchSelectShow()"
  72      onmouseout="return searchBox.OnSearchSelectHide()"
  73      onkeydown="return searchBox.OnSearchSelectKey(event)">
  74 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Groups</a></div>
  75
  76 <!-- iframe showing the search results (closed by default) -->
  77 <div id="MSearchResultsWindow">
  78 <iframe src="javascript:void(0)" frameborder="0"
  79         name="MSearchResults" id="MSearchResults">
  80 </iframe>
  81 </div>
  82
  83 <div id="nav-path" class="navpath">
  84   <ul>
  85 <li class="navelem"><b>boost</b></li><li class="navelem"><b>geometry</b></li><li class="navelem"><b>index</b></li><li class="navelem"><a class="el" href="structboost_1_1geometry_1_1index_1_1equal__to.html">equal_to</a></li>  </ul>
  86 </div>
  87 </div><!-- top -->
  88 <div class="header">
  89   <div class="summary">
  90 <a href="#pub-types">Public Types</a> &#124;
  91 <a href="#pub-methods">Public Member Functions</a> &#124;
  92 <a href="structboost_1_1geometry_1_1index_1_1equal__to-members.html">List of all members</a>  </div>
  93   <div class="headertitle">
  94 <div class="title">boost::geometry::index::equal_to&lt; Value &gt; Struct Template Reference</div>  </div>
  95 </div><!--header-->
  96 <div class="contents">
  97
  98 <p>The function object comparing Values.
  99  <a href="structboost_1_1geometry_1_1index_1_1equal__to.html#details">More...</a></p>
 100
 101 <p><code>#include &lt;<a class="el" href="equal__to_8hpp_source.html">equal_to.hpp</a>&gt;</code></p>
 102 <div class="dynheader">
 103 Inheritance diagram for boost::geometry::index::equal_to&lt; Value &gt;:</div>
 104 <div class="dyncontent">
 105  <div class="center">
 106   <img src="structboost_1_1geometry_1_1index_1_1equal__to.png" usemap="#boost::geometry::index::equal_to&lt; Value &gt;_map" alt=""/>
 107   <map id="boost::geometry::index::equal_to&lt; Value &gt;_map" name="boost::geometry::index::equal_to&lt; Value &gt;_map">
 108 <area href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html" alt="boost::geometry::index::detail::equal_to&lt; Value &gt;" shape="rect" coords="0,0,282,24"/>
 109 </map>
 110  </div></div>
 111 <table class="memberdecls">
 112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
 113 Public Types</h2></td></tr>
 114 <tr class="memitem:ae6a986988e380c2ba4afa646294cfd93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6a986988e380c2ba4afa646294cfd93"></a>
 115 typedef <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html">detail::equal_to</a><br class="typebreak"/>
 116 &lt; Value &gt;::<a class="el" href="structboost_1_1geometry_1_1index_1_1equal__to.html#ae6a986988e380c2ba4afa646294cfd93">result_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1equal__to.html#ae6a986988e380c2ba4afa646294cfd93">result_type</a></td></tr>
 117 <tr class="memdesc:ae6a986988e380c2ba4afa646294cfd93"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of result returned by function object. <br/></td></tr>
 118 <tr class="separator:ae6a986988e380c2ba4afa646294cfd93"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="inherit_header pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html">boost::geometry::index::detail::equal_to&lt; Value &gt;</a></td></tr>
 120 <tr class="memitem:afb53f9416414ba2c5faa0cf372fd8f16 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb53f9416414ba2c5faa0cf372fd8f16"></a>
 121 typedef bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html#afb53f9416414ba2c5faa0cf372fd8f16">result_type</a></td></tr>
 122 <tr class="memdesc:afb53f9416414ba2c5faa0cf372fd8f16 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of result returned by function object. <br/></td></tr>
 123 <tr class="separator:afb53f9416414ba2c5faa0cf372fd8f16 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 </table><table class="memberdecls">
 125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 126 Public Member Functions</h2></td></tr>
 127 <tr class="memitem:adb497915885d69df9aff938d16922ff3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1equal__to.html#adb497915885d69df9aff938d16922ff3">operator()</a> (Value const &amp;l, Value const &amp;r) const </td></tr>
 128 <tr class="memdesc:adb497915885d69df9aff938d16922ff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare Values.  <a href="#adb497915885d69df9aff938d16922ff3">More...</a><br/></td></tr>
 129 <tr class="separator:adb497915885d69df9aff938d16922ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="inherit_header pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html">boost::geometry::index::detail::equal_to&lt; Value &gt;</a></td></tr>
 131 <tr class="memitem:a2fcd9ed3a5085a2dc4914976c0a1cabb inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to.html#a2fcd9ed3a5085a2dc4914976c0a1cabb">operator()</a> (Value const &amp;l, Value const &amp;r) const</td></tr>
 132 <tr class="memdesc:a2fcd9ed3a5085a2dc4914976c0a1cabb inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare values. If Value is a Geometry geometry::equals() function is used.  <a href="#a2fcd9ed3a5085a2dc4914976c0a1cabb">More...</a><br/></td></tr>
 133 <tr class="separator:a2fcd9ed3a5085a2dc4914976c0a1cabb inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 </table>
 135 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 136 <div class="textblock"><h3>template&lt;typename Value&gt;<br/>
 137 struct boost::geometry::index::equal_to&lt; Value &gt;</h3>
 138
 139 <p>The function object comparing Values. </p>
 140 <p>The default version handles Values which are Indexables, std::pair&lt;T1, T2&gt;, boost::tuple&lt;...&gt; and std::tuple&lt;...&gt; if STD tuples and variadic templates are supported. All members are compared from left to right, Geometries using boost::geometry::equals() function, other types using operator==.</p>
 141 <dl class="tparams"><dt>Template Parameters</dt><dd>
 142   <table class="tparams">
 143     <tr><td class="paramname">Value</td><td>The type of objects which are compared by this function object. </td></tr>
 144   </table>
 145   </dd>
 146 </dl>
 147 </div><h2 class="groupheader">Member Function Documentation</h2>
 148 <a class="anchor" id="adb497915885d69df9aff938d16922ff3"></a>
 149 <div class="memitem">
 150 <div class="memproto">
 151 <div class="memtemplate">
 152 template&lt;typename Value &gt; </div>
 153 <table class="mlabels">
 154   <tr>
 155   <td class="mlabels-left">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">bool <a class="el" href="structboost_1_1geometry_1_1index_1_1equal__to.html">boost::geometry::index::equal_to</a>&lt; Value &gt;::operator() </td>
 159           <td>(</td>
 160           <td class="paramtype">Value const &amp;&#160;</td>
 161           <td class="paramname"><em>l</em>, </td>
 162         </tr>
 163         <tr>
 164           <td class="paramkey"></td>
 165           <td></td>
 166           <td class="paramtype">Value const &amp;&#160;</td>
 167           <td class="paramname"><em>r</em>&#160;</td>
 168         </tr>
 169         <tr>
 170           <td></td>
 171           <td>)</td>
 172           <td></td><td> const</td>
 173         </tr>
 174       </table>
 175   </td>
 176   <td class="mlabels-right">
 177 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 178   </tr>
 179 </table>
 180 </div><div class="memdoc">
 181
 182 <p>Compare Values. </p>
 183 <dl class="params"><dt>Parameters</dt><dd>
 184   <table class="params">
 185     <tr><td class="paramname">l</td><td>First value. </td></tr>
 186     <tr><td class="paramname">r</td><td>Second value. </td></tr>
 187   </table>
 188   </dd>
 189 </dl>
 190 <dl class="section return"><dt>Returns</dt><dd>true if Values are equal. </dd></dl>
 191
 192 </div>
 193 </div>
 194 <hr/>The documentation for this struct was generated from the following file:<ul>
 195 <li>/home/ubuntu/boost/boost/geometry/index/<a class="el" href="equal__to_8hpp_source.html">equal_to.hpp</a></li>
 196 </ul>
 197 </div><!-- contents -->
 198 <!-- start footer part -->
 199 <hr class="footer"/><address class="footer"><small>
 200 Generated on Thu Dec 22 2016 12:40:17 for Boost.Geometry.Index by &#160;<a href="http://www.doxygen.org/index.html">
 201 <img class="footer" src="doxygen.png" alt="doxygen"/>
 202 </a> 1.8.6
 203 </small></address>
 204 </body>
 205 </html>