libs/geometry/doc/doxy/doxygen_output/xml/structboost_1_1geometry_1_1select__most__precise.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_1select__most__precise" kind="struct" prot="public">
   4     <compoundname>boost::geometry::select_most_precise</compoundname>
   5     <includes local="no">select_most_precise.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>typename</type>
   9         <declname>T1</declname>
  10         <defname>T1</defname>
  11       </param>
  12       <param>
  13         <type>typename</type>
  14         <declname>T2</declname>
  15         <defname>T2</defname>
  16         <defval>void</defval>
  17       </param>
  18       <param>
  19         <type>typename</type>
  20         <declname>T3</declname>
  21         <defname>T3</defname>
  22         <defval>void</defval>
  23       </param>
  24     </templateparamlist>
  25       <sectiondef kind="public-type">
  26       <memberdef kind="typedef" id="structboost_1_1geometry_1_1select__most__precise_1adcdc2e39793696fe62d24b1ad8235207" prot="public" static="no">
  27         <type><ref refid="structboost_1_1geometry_1_1select__most__precise" kindref="compound">select_most_precise</ref>&lt; typename <ref refid="structboost_1_1geometry_1_1select__most__precise" kindref="compound">select_most_precise</ref>&lt; T1, T2 &gt;::<ref refid="structboost_1_1geometry_1_1select__most__precise_1adcdc2e39793696fe62d24b1ad8235207" kindref="member">type</ref>, T3 &gt;::<ref refid="structboost_1_1geometry_1_1select__most__precise_1adcdc2e39793696fe62d24b1ad8235207" kindref="member">type</ref></type>
  28         <definition>typedef select_most_precise&lt; typename select_most_precise&lt;T1, T2&gt;::type, T3 &gt;::type boost::geometry::select_most_precise&lt; T1, T2, T3 &gt;::type</definition>
  29         <argsstring></argsstring>
  30         <name>type</name>
  31         <briefdescription>
  32         </briefdescription>
  33         <detaileddescription>
  34         </detaileddescription>
  35         <inbodydescription>
  36         </inbodydescription>
  37         <location file="/home/ubuntu/boost/boost/geometry/util/select_most_precise.hpp" line="129" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/util/select_most_precise.hpp" bodystart="129" bodyend="-1"/>
  38       </memberdef>
  39       </sectiondef>
  40     <briefdescription>
  41 <para>Meta-function to select, of two types, the most accurate type for calculations. </para>    </briefdescription>
  42     <detaileddescription>
  43 <para><ref refid="structboost_1_1geometry_1_1select__most__precise" kindref="compound">select_most_precise</ref> classes, compares two types on compile time. For example, if an addition must be done with a double and an integer, the result must be a double. If both types are integer, the result can be an integer. <simplesect kind="note"><para>It is different from the &quot;promote&quot; class, already in boost. That class promotes e.g. a (one) float to a double. This class selects a type from two types. It takes the most accurate, but does not promote afterwards. </para><simplesectsep/><para>This traits class is completely independant from GGL and might be a separate addition to Boost </para><simplesectsep/><para>If the input is a non-fundamental type, it might be a calculation type such as a GMP-value or another high precision value. Therefore, if one is non-fundamental, that one is chosen. </para><simplesectsep/><para>If both types are non-fundamental, the result is indeterminate and currently the first one is chosen. </para></simplesect>
  44 </para>    </detaileddescription>
  45     <location file="/home/ubuntu/boost/boost/geometry/util/select_most_precise.hpp" line="124" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/util/select_most_precise.hpp" bodystart="123" bodyend="130"/>
  46     <listofallmembers>
  47       <member refid="structboost_1_1geometry_1_1select__most__precise_1adcdc2e39793696fe62d24b1ad8235207" prot="public" virt="non-virtual"><scope>boost::geometry::select_most_precise</scope><name>type</name></member>
  48     </listofallmembers>
  49   </compounddef>
  50 </doxygen>