EQ2EMu/EQ2/source/depends/boost_1_72_0/libs/geometry/doc/generated/segment.qbk

[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.

  Use, modification and distribution is subject to the Boost Software License,
  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]


[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1segment.xml]
[section:model_segment model::segment]

'''<indexterm><primary>model</primary></indexterm><indexterm><primary>segment</primary></indexterm>'''
Class segment: small class containing two points. 

[heading Description]
From Wikipedia: In geometry, a line segment is a part of a line that is bounded by two distinct end points, and contains every point on the line between its end points. 

[heading Model of]
[link geometry.reference.concepts.concept_segment Segment Concept]

[heading Synopsis]
``template<typename Point>
class model::segment
      : public std::pair< Point, Point >
{
  // ...
};
``

[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point] []]
]

[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``segment()``

] [Default constructor, no initialization. ] [

]]
[[``segment(Point const & p1, Point const & p2)``

] [Constructor taking the first and the second point. ] [[* Point const &]: ['p1]:  

[* Point const &]: ['p2]:  



]]
]

[heading Header]
Either

`#include <boost/geometry/geometries/geometries.hpp>`


Or

`#include <boost/geometry/geometries/segment.hpp>`

[include reference/geometries/segment.qbk]

[endsect]