boost_tuple.qbk 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
  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:boost_tuple Boost.Tuple]
  11. Boost.Tuple tuples with arithmetic elements can be used as
  12. points within Boost.Geometry
  13. [heading Description]
  14. Boost.Tuple fixed sized collections, such as boost::tuple<double, double>, are
  15. (optionally) adapted to the Boost.Geometry point concept.
  16. Boost.Tuple pairs or triples might have mutually different types, such as a
  17. boost::tuple<float, double>. Boost.Geometry reports the first type as its
  18. [link geometry.reference.core.coordinate_type coordinate_type].
  19. Boost.Geometry supports Boost.Tuple pairs, triples, quadruples, etc up to
  20. tuples with 10 elements (though most algorithms do not support so many
  21. dimensions).
  22. A tuple can be the point type used by the models linestring, polygon, segment,
  23. box, and ring.
  24. [heading Model of]
  25. [link geometry.reference.concepts.concept_point Point Concept]
  26. [heading Header]
  27. `#include <boost/geometry/geometries/adapted/boost_tuple.hpp>`
  28. __not_in_boost_geometry_hpp__
  29. [heading Example]
  30. [boost_tuple]
  31. [boost_tuple_output]
  32. [endsect]