geometry/doc/generated/linestring.qbk
Barend Gehrels 9382f261fb Doc update, moved reference/* to generated/* and ref/* to reference/*
doxygen_xml2qbk escaping of underscores

[SVN r69328]
2011-02-27 14:02:14 +00:00

72 lines
2.0 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
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, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1linestring.xml]
[section:model_linestring model::linestring]
A linestring (named so by OGC) is a collection (default a vector) of points.
[heading Model of]
[link geometry.reference.concepts.concept_linestring Linestring Concept]
[heading Synopsis]
``template<typename Point, template< typename, typename > class Container, template< typename > class Allocator>
class model::linestring
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[typename Point] [] [Any type fulfilling a Point Concept ]]
[[template< typename, typename > class Container] [std::vector] [container type, for example std::vector, std::deque ]]
[[template< typename > class Allocator] [std::allocator] [container-allocator-type]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``linestring``
] [Default constructor, creating an empty linestring. ] [
]]
[[``template<typename Iterator>
linestring(Iterator begin, Iterator end)``
] [Constructor with begin and end, filling the linestring. ] [[* Iterator]: ['begin]:
[* Iterator]: ['end]:
]]
]
[heading Header]
Either
`#include <boost/geometry/geometries/geometries.hpp>`
Or
`#include <boost/geometry/geometries/linestring.hpp>`
[endsect]