libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer.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_1centroid_1_1bashein__detmer" kind="class" prot="public">
   4     <compoundname>boost::geometry::strategy::centroid::bashein_detmer</compoundname>
   5     <includes local="no">centroid_bashein_detmer.hpp</includes>
   6     <innerclass refid="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1_1sums" prot="private">boost::geometry::strategy::centroid::bashein_detmer::sums</innerclass>
   7     <templateparamlist>
   8       <param>
   9         <type>typename Point</type>
  10       </param>
  11       <param>
  12         <type>typename PointOfSegment</type>
  13         <defval>Point</defval>
  14       </param>
  15       <param>
  16         <type>typename CalculationType</type>
  17         <defval>void</defval>
  18       </param>
  19     </templateparamlist>
  20       <sectiondef kind="private-type">
  21       <memberdef kind="typedef" id="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a9e09dd4618f4143f02ebdfd3d255564b" prot="private" static="no">
  22         <type>boost::mpl::if_c&lt; boost::is_void&lt; CalculationType &gt;::type::value, typename <ref refid="structboost_1_1geometry_1_1select__most__precise" kindref="compound">select_most_precise</ref>&lt; typename <ref refid="structboost_1_1geometry_1_1select__coordinate__type" kindref="compound">select_coordinate_type</ref>&lt; Point, PointOfSegment &gt;::type, double &gt;::type, CalculationType &gt;::type</type>
  23         <definition>typedef boost::mpl::if_c&lt; boost::is_void&lt;CalculationType&gt;::type::value, typename select_most_precise &lt; typename select_coordinate_type &lt; Point, PointOfSegment &gt;::type, double &gt;::type, CalculationType &gt;::type boost::geometry::strategy::centroid::bashein_detmer&lt; Point, PointOfSegment, CalculationType &gt;::calculation_type</definition>
  24         <argsstring></argsstring>
  25         <name>calculation_type</name>
  26         <briefdescription>
  27         </briefdescription>
  28         <detaileddescription>
  29         </detaileddescription>
  30         <inbodydescription>
  31         </inbodydescription>
  32         <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" line="148" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" bodystart="148" bodyend="-1"/>
  33       </memberdef>
  34       </sectiondef>
  35       <sectiondef kind="public-type">
  36       <memberdef kind="typedef" id="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a1d72fc25ea074c7ff644c192f78480d3" prot="public" static="no">
  37         <type>sums</type>
  38         <definition>typedef sums boost::geometry::strategy::centroid::bashein_detmer&lt; Point, PointOfSegment, CalculationType &gt;::state_type</definition>
  39         <argsstring></argsstring>
  40         <name>state_type</name>
  41         <briefdescription>
  42         </briefdescription>
  43         <detaileddescription>
  44         </detaileddescription>
  45         <inbodydescription>
  46         </inbodydescription>
  47         <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" line="169" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" bodystart="169" bodyend="-1"/>
  48       </memberdef>
  49       </sectiondef>
  50       <sectiondef kind="public-static-func">
  51       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a3ac9cabcaceb2dd6691c043c90956164" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
  52         <type>void</type>
  53         <definition>static void boost::geometry::strategy::centroid::bashein_detmer&lt; Point, PointOfSegment, CalculationType &gt;::apply</definition>
  54         <argsstring>(PointOfSegment const &amp;p1, PointOfSegment const &amp;p2, sums &amp;state)</argsstring>
  55         <name>apply</name>
  56         <param>
  57           <type>PointOfSegment const &amp;</type>
  58           <declname>p1</declname>
  59         </param>
  60         <param>
  61           <type>PointOfSegment const &amp;</type>
  62           <declname>p2</declname>
  63         </param>
  64         <param>
  65           <type>sums &amp;</type>
  66           <declname>state</declname>
  67         </param>
  68         <briefdescription>
  69         </briefdescription>
  70         <detaileddescription>
  71         </detaileddescription>
  72         <inbodydescription>
  73         </inbodydescription>
  74         <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" line="171" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" bodystart="171" bodyend="195"/>
  75       </memberdef>
  76       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1aa4ea6f887dbe3817949259c4193355c3" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
  77         <type>bool</type>
  78         <definition>static bool boost::geometry::strategy::centroid::bashein_detmer&lt; Point, PointOfSegment, CalculationType &gt;::result</definition>
  79         <argsstring>(sums const &amp;state, Point &amp;centroid)</argsstring>
  80         <name>result</name>
  81         <param>
  82           <type>sums const &amp;</type>
  83           <declname>state</declname>
  84         </param>
  85         <param>
  86           <type>Point &amp;</type>
  87           <declname>centroid</declname>
  88         </param>
  89         <briefdescription>
  90         </briefdescription>
  91         <detaileddescription>
  92         </detaileddescription>
  93         <inbodydescription>
  94         </inbodydescription>
  95         <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" line="197" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" bodystart="197" bodyend="225"/>
  96       </memberdef>
  97       </sectiondef>
  98     <briefdescription>
  99 <para>Centroid calculation using algorithm Bashein / Detmer. </para>    </briefdescription>
 100     <detaileddescription>
 101 <para>Calculates centroid using triangulation method published by Bashein / Detmer <parameterlist kind="templateparam"><parameteritem>
 102 <parameternamelist>
 103 <parametername>Point</parametername>
 104 </parameternamelist>
 105 <parameterdescription>
 106 <para>point type of centroid to calculate </para></parameterdescription>
 107 </parameteritem>
 108 <parameteritem>
 109 <parameternamelist>
 110 <parametername>PointOfSegment</parametername>
 111 </parameternamelist>
 112 <parameterdescription>
 113 <para>point type of segments, defaults to Point </para></parameterdescription>
 114 </parameteritem>
 115 <parameteritem>
 116 <parameternamelist>
 117 <parametername>CalculationType</parametername>
 118 </parameternamelist>
 119 <parameterdescription>
 120 <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>
 121 </parameteritem>
 122 </parameterlist>
 123 <simplesect kind="author"><para>Adapted from &quot;Centroid of a Polygon&quot; by Gerard Bashein and Paul R. Detmer<emphasis>, in &quot;Graphics Gems IV&quot;, Academic Press, 1994</emphasis></para></simplesect>
 124  <qbk>
 125 [heading See also]
 126 [link geometry.reference.algorithms.centroid.centroid_3_with_strategy centroid (with strategy)]
 127 </qbk>  </para>    </detaileddescription>
 128     <location file="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" line="128" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp" bodystart="127" bodyend="227"/>
 129     <listofallmembers>
 130       <member refid="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a3ac9cabcaceb2dd6691c043c90956164" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::centroid::bashein_detmer</scope><name>apply</name></member>
 131       <member refid="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a9e09dd4618f4143f02ebdfd3d255564b" prot="private" virt="non-virtual"><scope>boost::geometry::strategy::centroid::bashein_detmer</scope><name>calculation_type</name></member>
 132       <member refid="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1aa4ea6f887dbe3817949259c4193355c3" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::centroid::bashein_detmer</scope><name>result</name></member>
 133       <member refid="classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer_1a1d72fc25ea074c7ff644c192f78480d3" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::centroid::bashein_detmer</scope><name>state_type</name></member>
 134     </listofallmembers>
 135   </compounddef>
 136 </doxygen>