libs/geometry/doc/doxy/doxygen_output/xml/group__make.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="group__make" kind="group">
   4     <compoundname>make</compoundname>
   5     <title>make: construct geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__make_1gab8c2f53b1696956874ed69114cef3a94" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>typename Geometry</type>
  11           </param>
  12           <param>
  13             <type>typename Type</type>
  14           </param>
  15         </templateparamlist>
  16         <type>Geometry</type>
  17         <definition>Geometry boost::geometry::make</definition>
  18         <argsstring>(Type const &amp;c1, Type const &amp;c2)</argsstring>
  19         <name>make</name>
  20         <param>
  21           <type>Type const &amp;</type>
  22           <declname>c1</declname>
  23         </param>
  24         <param>
  25           <type>Type const &amp;</type>
  26           <declname>c2</declname>
  27         </param>
  28         <briefdescription>
  29 <para>Construct a geometry. </para>        </briefdescription>
  30         <detaileddescription>
  31 <para><simplesect kind="note"><para>It does not work with array-point types, like int[2] </para></simplesect>
  32 <parameterlist kind="templateparam"><parameteritem>
  33 <parameternamelist>
  34 <parametername>Geometry</parametername>
  35 </parameternamelist>
  36 <parameterdescription>
  37 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  38 </parameteritem>
  39 <parameteritem>
  40 <parameternamelist>
  41 <parametername>Type</parametername>
  42 </parameternamelist>
  43 <parameterdescription>
  44 <para>numerical type (int, double, ttmath, ...) to specify the coordinates </para></parameterdescription>
  45 </parameteritem>
  46 </parameterlist>
  47 <parameterlist kind="param"><parameteritem>
  48 <parameternamelist>
  49 <parametername>c1</parametername>
  50 </parameternamelist>
  51 <parameterdescription>
  52 <para>First coordinate (usually x-coordinate) </para></parameterdescription>
  53 </parameteritem>
  54 <parameteritem>
  55 <parameternamelist>
  56 <parametername>c2</parametername>
  57 </parameternamelist>
  58 <parameterdescription>
  59 <para>Second coordinate (usually y-coordinate) </para></parameterdescription>
  60 </parameteritem>
  61 </parameterlist>
  62 <simplesect kind="return"><para>The constructed geometry, here: a 2D point</para></simplesect>
  63  <qbk.distinguish> 2 coordinate values</qbk.distinguish>   <qbk>
  64 [heading Example]
  65 [make_2d_point] [make_2d_point_output]
  66
  67 [heading See also]
  68 \* [link geometry.reference.algorithms.assign.assign_values_3_2_coordinate_values assign]
  69 </qbk>  </para>        </detaileddescription>
  70         <inbodydescription>
  71         </inbodydescription>
  72         <location file="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" line="79" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" bodystart="79" bodyend="91"/>
  73       </memberdef>
  74       <memberdef kind="function" id="group__make_1gacab36dbf4f41c6994fb66600303dfe3b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  75         <templateparamlist>
  76           <param>
  77             <type>typename Geometry</type>
  78           </param>
  79           <param>
  80             <type>typename Type</type>
  81           </param>
  82         </templateparamlist>
  83         <type>Geometry</type>
  84         <definition>Geometry boost::geometry::make</definition>
  85         <argsstring>(Type const &amp;c1, Type const &amp;c2, Type const &amp;c3)</argsstring>
  86         <name>make</name>
  87         <param>
  88           <type>Type const &amp;</type>
  89           <declname>c1</declname>
  90         </param>
  91         <param>
  92           <type>Type const &amp;</type>
  93           <declname>c2</declname>
  94         </param>
  95         <param>
  96           <type>Type const &amp;</type>
  97           <declname>c3</declname>
  98         </param>
  99         <briefdescription>
 100 <para>Construct a geometry. </para>        </briefdescription>
 101         <detaileddescription>
 102 <para><parameterlist kind="templateparam"><parameteritem>
 103 <parameternamelist>
 104 <parametername>Geometry</parametername>
 105 </parameternamelist>
 106 <parameterdescription>
 107 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
 108 </parameteritem>
 109 <parameteritem>
 110 <parameternamelist>
 111 <parametername>Type</parametername>
 112 </parameternamelist>
 113 <parameterdescription>
 114 <para>numerical type (int, double, ttmath, ...) to specify the coordinates </para></parameterdescription>
 115 </parameteritem>
 116 </parameterlist>
 117 <parameterlist kind="param"><parameteritem>
 118 <parameternamelist>
 119 <parametername>c1</parametername>
 120 </parameternamelist>
 121 <parameterdescription>
 122 <para>First coordinate (usually x-coordinate) </para></parameterdescription>
 123 </parameteritem>
 124 <parameteritem>
 125 <parameternamelist>
 126 <parametername>c2</parametername>
 127 </parameternamelist>
 128 <parameterdescription>
 129 <para>Second coordinate (usually y-coordinate) </para></parameterdescription>
 130 </parameteritem>
 131 <parameteritem>
 132 <parameternamelist>
 133 <parametername>c3</parametername>
 134 </parameternamelist>
 135 <parameterdescription>
 136 <para>Third coordinate (usually z-coordinate) </para></parameterdescription>
 137 </parameteritem>
 138 </parameterlist>
 139 <simplesect kind="return"><para>The constructed geometry, here: a 3D point</para></simplesect>
 140  <qbk.distinguish> 3 coordinate values</qbk.distinguish>   <qbk>
 141 [heading Example]
 142 [make_3d_point] [make_3d_point_output]
 143
 144 [heading See also]
 145 \* [link geometry.reference.algorithms.assign.assign_values_4_3_coordinate_values assign]
 146 </qbk>  </para>        </detaileddescription>
 147         <inbodydescription>
 148         </inbodydescription>
 149         <location file="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" line="113" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" bodystart="113" bodyend="125"/>
 150       </memberdef>
 151       <memberdef kind="function" id="group__make_1gabf487e6de983091aa6003f792b1b05df" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 152         <templateparamlist>
 153           <param>
 154             <type>typename Geometry</type>
 155           </param>
 156         </templateparamlist>
 157         <type>Geometry</type>
 158         <definition>Geometry boost::geometry::make_inverse</definition>
 159         <argsstring>()</argsstring>
 160         <name>make_inverse</name>
 161         <briefdescription>
 162 <para>Construct a box with inverse infinite coordinates. </para>        </briefdescription>
 163         <detaileddescription>
 164 <para>The make_inverse function initializes a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is useful e.g. in combination with the expand function, to determine the bounding box of a series of geometries. <parameterlist kind="templateparam"><parameteritem>
 165 <parameternamelist>
 166 <parametername>Geometry</parametername>
 167 </parameternamelist>
 168 <parameterdescription>
 169 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
 170 </parameteritem>
 171 </parameterlist>
 172 <simplesect kind="return"><para>The constructed geometry, here: a box</para></simplesect>
 173  <qbk>
 174 [heading Example]
 175 [make_inverse] [make_inverse_output]
 176
 177 [heading See also]
 178 \* [link geometry.reference.algorithms.assign.assign_inverse assign_inverse]
 179 </qbk>  </para>        </detaileddescription>
 180         <inbodydescription>
 181         </inbodydescription>
 182         <location file="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" line="164" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" bodystart="164" bodyend="175"/>
 183       </memberdef>
 184       <memberdef kind="function" id="group__make_1ga06bcbd65d487f8dad0ebdab1f08aefa6" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 185         <templateparamlist>
 186           <param>
 187             <type>typename Geometry</type>
 188           </param>
 189         </templateparamlist>
 190         <type>Geometry</type>
 191         <definition>Geometry boost::geometry::make_zero</definition>
 192         <argsstring>()</argsstring>
 193         <name>make_zero</name>
 194         <briefdescription>
 195 <para>Construct a geometry with its coordinates initialized to zero. </para>        </briefdescription>
 196         <detaileddescription>
 197 <para>The make_zero function initializes a 2D or 3D point or box with coordinates of zero <parameterlist kind="templateparam"><parameteritem>
 198 <parameternamelist>
 199 <parametername>Geometry</parametername>
 200 </parameternamelist>
 201 <parameterdescription>
 202 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
 203 </parameteritem>
 204 </parameterlist>
 205 <simplesect kind="return"><para>The constructed and zero-initialized geometry </para></simplesect>
 206 </para>        </detaileddescription>
 207         <inbodydescription>
 208         </inbodydescription>
 209         <location file="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" line="185" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/make.hpp" bodystart="185" bodyend="196"/>
 210       </memberdef>
 211       </sectiondef>
 212     <briefdescription>
 213     </briefdescription>
 214     <detaileddescription>
 215     </detaileddescription>
 216   </compounddef>
 217 </doxygen>