segment.qbk 1.6 KB

1234567891011121314151617181920212223242526272829303132333435
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
  4. Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
  5. Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [section:concept_segment Segment Concept]
  11. [heading Description]
  12. [concept Segment..segment]
  13. [heading Concept Definition]
  14. * there must be a specialization of `traits::tag` defining `segment_tag` as type
  15. * there must be a specialization of `traits::point_type` to define the underlying point type
  16. (even if it does not consist of points, it should define this type, to indicate the points it can work with)
  17. * there must be a specialization of `traits::indexed_access`, per index and per dimension, with two functions:
  18. * `get` to get a coordinate value
  19. * `set` to set a coordinate value (this one is not checked for ConstSegment)
  20. [note The segment concept is similar to the box concept, defining using another tag.
  21. However, the box concept assumes the index as `min_corner`, `max_corner`, while for the segment concept, there is no assumption.]
  22. [heading Available Models]
  23. * [link geometry.reference.models.model_segment model::segment]
  24. * [link geometry.reference.models.model_referring_segment referring segment]
  25. [endsect]