diff options
author | Lorry Tar Creator <lorry-tar-importer@baserock.org> | 2013-06-25 22:59:01 +0000 |
---|---|---|
committer | <> | 2013-09-27 11:49:28 +0000 |
commit | 8c4528713d907ee2cfd3bfcbbad272c749867f84 (patch) | |
tree | c09e2ce80f47b90c85cc720f5139089ad9c8cfff /libs/geometry/doc/concept/segment.qbk | |
download | boost-tarball-8c4528713d907ee2cfd3bfcbbad272c749867f84.tar.gz |
Imported from /home/lorry/working-area/delta_boost-tarball/boost_1_54_0.tar.bz2.boost_1_54_0baserock/morph
Diffstat (limited to 'libs/geometry/doc/concept/segment.qbk')
-rw-r--r-- | libs/geometry/doc/concept/segment.qbk | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/libs/geometry/doc/concept/segment.qbk b/libs/geometry/doc/concept/segment.qbk new file mode 100644 index 000000000..48c3af45f --- /dev/null +++ b/libs/geometry/doc/concept/segment.qbk @@ -0,0 +1,35 @@ +[/============================================================================ + Boost.Geometry (aka GGL, Generic Geometry Library) + + Copyright (c) 2009-2012 Mateusz Loskot, London, UK. + Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands. + Copyright (c) 2009-2012 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) +=============================================================================/] + +[section:concept_segment Segment Concept] + +[heading Description] +[concept Segment..segment] + + +[heading Concept Definition] + +* there must be a specialization of `traits::tag` defining `segment_tag` as type +* there must be a specialization of `traits::point_type` 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) +* there must be a specialization of `traits::indexed_access`, per index and per dimension, with two functions: + * `get` to get a coordinate value + * `set` to set a coordinate value (this one is not checked for ConstSegment) + +[note The segment concept is similar to the box concept, defining using another tag. +However, the box concept assumes the index as `min_corner`, `max_corner`, while for the segment concept, there is no assumption.] + +[heading Available Models] +* [link geometry.reference.models.model_segment model::segment] +* [link geometry.reference.models.model_referring_segment referring segment] + +[endsect] |