ceph/src/boost/libs/geometry/doc/reference/geometries/adapted/boost_tuple.qbk

   1 [/============================================================================
   2   Boost.Geometry (aka GGL, Generic Geometry Library)
   3
   4   Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
   5   Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
   6   Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
   7
   8   Use, modification and distribution is subject to the Boost Software License,
   9   Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  10   http://www.boost.org/LICENSE_1_0.txt)
  11 =============================================================================/]
  12
  13 [section:boost_tuple Boost.Tuple]
  14
  15 Boost.Tuple tuples with arithmetic elements can be used as
  16 points within Boost.Geometry
  17
  18 [heading Description]
  19
  20 Boost.Tuple fixed sized collections, such as boost::tuple<double, double>, are
  21 (optionally) adapted to the Boost.Geometry point concept.
  22
  23 Boost.Tuple pairs or triples might have mutually different types, such as a
  24 boost::tuple<float, double>. Boost.Geometry reports the first type as its
  25 [link geometry.reference.core.coordinate_type coordinate_type].
  26
  27 Boost.Geometry supports Boost.Tuple pairs, triples, quadruples, etc up to
  28 tuples with 10 elements (though most algorithms do not support so many
  29 dimensions).
  30
  31 A tuple can be the point type used by the models linestring, polygon, segment,
  32 box, and ring
  33
  34 [heading Model of]
  35 [link geometry.reference.concepts.concept_point Point Concept]
  36
  37 [heading Header]
  38 `#include <boost/geometry/geometries/adapted/boost_tuple.hpp>`
  39
  40 __not_in_boost_geometry_hpp__
  41
  42 [heading Example]
  43 [boost_tuple]
  44 [boost_tuple_output]
  45
  46 [endsect]
  47