libs/geometry/doc/index/xml/structboost_1_1geometry_1_1index_1_1equal__to.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="structboost_1_1geometry_1_1index_1_1equal__to" kind="struct" prot="public">
   4     <compoundname>boost::geometry::index::equal_to</compoundname>
   5     <basecompoundref refid="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to" prot="public" virt="non-virtual">boost::geometry::index::detail::equal_to&lt; Value &gt;</basecompoundref>
   6     <includes refid="equal__to_8hpp" local="no">equal_to.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename Value</type>
  10       </param>
  11     </templateparamlist>
  12       <sectiondef kind="public-type">
  13       <memberdef kind="typedef" id="structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93" prot="public" static="no">
  14         <type><ref refid="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to" kindref="compound">detail::equal_to</ref>&lt; Value &gt;::<ref refid="structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93" kindref="member">result_type</ref></type>
  15         <definition>typedef detail::equal_to&lt;Value&gt;::result_type boost::geometry::index::equal_to&lt; Value &gt;::result_type</definition>
  16         <argsstring></argsstring>
  17         <name>result_type</name>
  18         <briefdescription>
  19 <para>The type of result returned by function object. </para>        </briefdescription>
  20         <detaileddescription>
  21         </detaileddescription>
  22         <inbodydescription>
  23         </inbodydescription>
  24         <location file="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" line="241" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" bodystart="241" bodyend="-1"/>
  25       </memberdef>
  26       </sectiondef>
  27       <sectiondef kind="public-func">
  28       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1equal__to_1adb497915885d69df9aff938d16922ff3" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
  29         <type>bool</type>
  30         <definition>bool boost::geometry::index::equal_to&lt; Value &gt;::operator()</definition>
  31         <argsstring>(Value const &amp;l, Value const &amp;r) const </argsstring>
  32         <name>operator()</name>
  33         <param>
  34           <type>Value const &amp;</type>
  35           <declname>l</declname>
  36         </param>
  37         <param>
  38           <type>Value const &amp;</type>
  39           <declname>r</declname>
  40         </param>
  41         <briefdescription>
  42 <para>Compare Values. </para>        </briefdescription>
  43         <detaileddescription>
  44 <para><parameterlist kind="param"><parameteritem>
  45 <parameternamelist>
  46 <parametername>l</parametername>
  47 </parameternamelist>
  48 <parameterdescription>
  49 <para>First value. </para></parameterdescription>
  50 </parameteritem>
  51 <parameteritem>
  52 <parameternamelist>
  53 <parametername>r</parametername>
  54 </parameternamelist>
  55 <parameterdescription>
  56 <para>Second value. </para></parameterdescription>
  57 </parameteritem>
  58 </parameterlist>
  59 <simplesect kind="return"><para>true if Values are equal. </para></simplesect>
  60 </para>        </detaileddescription>
  61         <inbodydescription>
  62         </inbodydescription>
  63         <location file="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" line="250" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" bodystart="250" bodyend="253"/>
  64       </memberdef>
  65       </sectiondef>
  66     <briefdescription>
  67 <para>The function object comparing Values. </para>    </briefdescription>
  68     <detaileddescription>
  69 <para>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==.</para><para><parameterlist kind="templateparam"><parameteritem>
  70 <parameternamelist>
  71 <parametername>Value</parametername>
  72 </parameternamelist>
  73 <parameterdescription>
  74 <para>The type of objects which are compared by this function object. </para></parameterdescription>
  75 </parameteritem>
  76 </parameterlist>
  77 </para>    </detaileddescription>
  78     <inheritancegraph>
  79       <node id="12">
  80         <label>boost::geometry::index::equal_to&lt; Value &gt;</label>
  81         <link refid="structboost_1_1geometry_1_1index_1_1equal__to"/>
  82         <childnode refid="13" relation="public-inheritance">
  83         </childnode>
  84       </node>
  85       <node id="13">
  86         <label>boost::geometry::index::detail::equal_to&lt; Value &gt;</label>
  87         <link refid="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"/>
  88       </node>
  89     </inheritancegraph>
  90     <collaborationgraph>
  91       <node id="14">
  92         <label>boost::geometry::index::equal_to&lt; Value &gt;</label>
  93         <link refid="structboost_1_1geometry_1_1index_1_1equal__to"/>
  94         <childnode refid="15" relation="public-inheritance">
  95         </childnode>
  96       </node>
  97       <node id="15">
  98         <label>boost::geometry::index::detail::equal_to&lt; Value &gt;</label>
  99         <link refid="structboost_1_1geometry_1_1index_1_1detail_1_1equal__to"/>
 100       </node>
 101     </collaborationgraph>
 102     <location file="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" line="239" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/equal_to.hpp" bodystart="237" bodyend="254"/>
 103     <listofallmembers>
 104       <member refid="structboost_1_1geometry_1_1index_1_1equal__to_1adb497915885d69df9aff938d16922ff3" prot="public" virt="non-virtual"><scope>boost::geometry::index::equal_to</scope><name>operator()</name></member>
 105       <member refid="structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93" prot="public" virt="non-virtual"><scope>boost::geometry::index::equal_to</scope><name>result_type</name></member>
 106     </listofallmembers>
 107   </compounddef>
 108 </doxygen>