libs/geometry/doc/doxy/doxygen_output/xml/structboost_1_1geometry_1_1strategy_1_1compare_1_1circular__comparator.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_1strategy_1_1compare_1_1circular__comparator" kind="struct" prot="public">
   4     <compoundname>boost::geometry::strategy::compare::circular_comparator</compoundname>
   5     <includes local="no">compare_circular.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>typename CoordinateType</type>
   9       </param>
  10       <param>
  11         <type>typename Units</type>
  12       </param>
  13       <param>
  14         <type>typename Compare</type>
  15       </param>
  16     </templateparamlist>
  17       <sectiondef kind="public-static-func">
  18       <memberdef kind="function" id="structboost_1_1geometry_1_1strategy_1_1compare_1_1circular__comparator_1aaf2fc7c5853acb07f338e445383d639b" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
  19         <type>CoordinateType</type>
  20         <definition>static CoordinateType boost::geometry::strategy::compare::circular_comparator&lt; CoordinateType, Units, Compare &gt;::put_in_range</definition>
  21         <argsstring>(CoordinateType const &amp;c, double min_border, double max_border)</argsstring>
  22         <name>put_in_range</name>
  23         <param>
  24           <type>CoordinateType const &amp;</type>
  25           <declname>c</declname>
  26         </param>
  27         <param>
  28           <type>double</type>
  29           <declname>min_border</declname>
  30         </param>
  31         <param>
  32           <type>double</type>
  33           <declname>max_border</declname>
  34         </param>
  35         <briefdescription>
  36         </briefdescription>
  37         <detaileddescription>
  38         </detaileddescription>
  39         <inbodydescription>
  40         </inbodydescription>
  41         <location file="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" line="63" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" bodystart="63" bodyend="76"/>
  42       </memberdef>
  43       </sectiondef>
  44       <sectiondef kind="public-func">
  45       <memberdef kind="function" id="structboost_1_1geometry_1_1strategy_1_1compare_1_1circular__comparator_1a6a4d4b7f812ffd92d04d3bdee5baf97c" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
  46         <type>bool</type>
  47         <definition>bool boost::geometry::strategy::compare::circular_comparator&lt; CoordinateType, Units, Compare &gt;::operator()</definition>
  48         <argsstring>(CoordinateType const &amp;c1, CoordinateType const &amp;c2) const </argsstring>
  49         <name>operator()</name>
  50         <param>
  51           <type>CoordinateType const &amp;</type>
  52           <declname>c1</declname>
  53         </param>
  54         <param>
  55           <type>CoordinateType const &amp;</type>
  56           <declname>c2</declname>
  57         </param>
  58         <briefdescription>
  59         </briefdescription>
  60         <detaileddescription>
  61         </detaileddescription>
  62         <inbodydescription>
  63         </inbodydescription>
  64         <location file="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" line="78" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" bodystart="78" bodyend="106"/>
  65       </memberdef>
  66       </sectiondef>
  67     <briefdescription>
  68 <para>Compare (in one direction) strategy for spherical coordinates. </para>    </briefdescription>
  69     <detaileddescription>
  70 <para><parameterlist kind="templateparam"><parameteritem>
  71 <parameternamelist>
  72 <parametername>Point</parametername>
  73 </parameternamelist>
  74 <parameterdescription>
  75 <para>point-type </para></parameterdescription>
  76 </parameteritem>
  77 <parameteritem>
  78 <parameternamelist>
  79 <parametername>Dimension</parametername>
  80 </parameternamelist>
  81 <parameterdescription>
  82 <para>dimension </para></parameterdescription>
  83 </parameteritem>
  84 </parameterlist>
  85 </para>    </detaileddescription>
  86     <location file="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" line="62" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/spherical/compare_circular.hpp" bodystart="61" bodyend="107"/>
  87     <listofallmembers>
  88       <member refid="structboost_1_1geometry_1_1strategy_1_1compare_1_1circular__comparator_1a6a4d4b7f812ffd92d04d3bdee5baf97c" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::compare::circular_comparator</scope><name>operator()</name></member>
  89       <member refid="structboost_1_1geometry_1_1strategy_1_1compare_1_1circular__comparator_1aaf2fc7c5853acb07f338e445383d639b" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::compare::circular_comparator</scope><name>put_in_range</name></member>
  90     </listofallmembers>
  91   </compounddef>
  92 </doxygen>