libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1concepts_1_1_segment.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_1concepts_1_1_segment" kind="class" prot="public">
   4     <compoundname>boost::geometry::concepts::Segment</compoundname>
   5     <includes local="no">segment_concept.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>typename Geometry</type>
   9       </param>
  10     </templateparamlist>
  11     <briefdescription>
  12 <para><ref refid="classboost_1_1geometry_1_1concepts_1_1_segment" kindref="compound">Segment</ref> concept. </para>    </briefdescription>
  13     <detaileddescription>
  14 <para>Formal definition: The segment concept is defined as following:<itemizedlist>
  15 <listitem><para>there must be a specialization of <ref refid="structboost_1_1geometry_1_1traits_1_1tag" kindref="compound">traits::tag</ref> defining <ref refid="structboost_1_1geometry_1_1segment__tag" kindref="compound">segment_tag</ref> as type</para></listitem><listitem><para>there must be a specialization of <ref refid="structboost_1_1geometry_1_1traits_1_1point__type" kindref="compound">traits::point_type</ref> to define the underlying point type (even if it does not consist of points, it should define this type, to indicate the points it can work with)</para></listitem><listitem><para>there must be a specialization of <ref refid="structboost_1_1geometry_1_1traits_1_1indexed__access" kindref="compound">traits::indexed_access</ref>, per index and per dimension, with two functions:<itemizedlist>
  16 <listitem><para>get to get a coordinate value</para></listitem><listitem><para>set to set a coordinate value (this one is not checked for <ref refid="classboost_1_1geometry_1_1concepts_1_1_const_segment" kindref="compound">ConstSegment</ref>)</para></listitem></itemizedlist>
  17 </para></listitem></itemizedlist>
  18 </para><para><simplesect kind="note"><para>The segment concept is similar to the box concept, defining another tag. However, the box concept assumes the index as min_corner, max_corner, while for the segment concept there is no assumption. </para></simplesect>
  19 </para>    </detaileddescription>
  20     <location file="/home/ubuntu/boost/boost/geometry/geometries/concepts/segment_concept.hpp" line="50" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/concepts/segment_concept.hpp" bodystart="49" bodyend="83"/>
  21     <listofallmembers>
  22     </listofallmembers>
  23   </compounddef>
  24 </doxygen>