libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras.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="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras" kind="class" prot="public">
   4     <compoundname>boost::geometry::strategy::distance::comparable::pythagoras</compoundname>
   5     <includes local="no">distance_pythagoras.hpp</includes>
   6     <innerclass refid="structboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras_1_1calculation__type" prot="public">boost::geometry::strategy::distance::comparable::pythagoras::calculation_type</innerclass>
   7     <templateparamlist>
   8       <param>
   9         <type>typename CalculationType</type>
  10         <defval>void</defval>
  11       </param>
  12     </templateparamlist>
  13       <sectiondef kind="public-static-func">
  14       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras_1a7fbf6d6e27820eaec64b1723d1e84d76" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
  15         <templateparamlist>
  16           <param>
  17             <type>typename Point1</type>
  18           </param>
  19           <param>
  20             <type>typename Point2</type>
  21           </param>
  22         </templateparamlist>
  23         <type><ref refid="structboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras_1_1calculation__type" kindref="compound">calculation_type</ref>&lt; Point1, Point2 &gt;::type</type>
  24         <definition>static calculation_type&lt;Point1, Point2&gt;::type boost::geometry::strategy::distance::comparable::pythagoras&lt; CalculationType &gt;::apply</definition>
  25         <argsstring>(Point1 const &amp;p1, Point2 const &amp;p2)</argsstring>
  26         <name>apply</name>
  27         <param>
  28           <type>Point1 const &amp;</type>
  29           <declname>p1</declname>
  30         </param>
  31         <param>
  32           <type>Point2 const &amp;</type>
  33           <declname>p2</declname>
  34         </param>
  35         <briefdescription>
  36         </briefdescription>
  37         <detaileddescription>
  38         </detaileddescription>
  39         <inbodydescription>
  40         </inbodydescription>
  41         <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/distance_pythagoras.hpp" line="92" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/distance_pythagoras.hpp" bodystart="92" bodyend="107"/>
  42       </memberdef>
  43       </sectiondef>
  44     <briefdescription>
  45 <para>Strategy to calculate comparable distance between two points. </para>    </briefdescription>
  46     <detaileddescription>
  47 <para><parameterlist kind="templateparam"><parameteritem>
  48 <parameternamelist>
  49 <parametername>Point1</parametername>
  50 </parameternamelist>
  51 <parameterdescription>
  52 <para>first point type </para></parameterdescription>
  53 </parameteritem>
  54 <parameteritem>
  55 <parameternamelist>
  56 <parametername>Point2</parametername>
  57 </parameternamelist>
  58 <parameterdescription>
  59 <para>second point type </para></parameterdescription>
  60 </parameteritem>
  61 <parameteritem>
  62 <parameternamelist>
  63 <parametername>CalculationType</parametername>
  64 </parameternamelist>
  65 <parameterdescription>
  66 <para>numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point </para></parameterdescription>
  67 </parameteritem>
  68 </parameterlist>
  69 </para>    </detaileddescription>
  70     <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/distance_pythagoras.hpp" line="75" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/distance_pythagoras.hpp" bodystart="74" bodyend="108"/>
  71     <listofallmembers>
  72       <member refid="classboost_1_1geometry_1_1strategy_1_1distance_1_1comparable_1_1pythagoras_1a7fbf6d6e27820eaec64b1723d1e84d76" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::distance::comparable::pythagoras</scope><name>apply</name></member>
  73     </listofallmembers>
  74   </compounddef>
  75 </doxygen>