libs/geometry/doc/generated/expand.qbk

   1 [/============================================================================
   2   Boost.Geometry (aka GGL, Generic Geometry Library)
   3
   4   Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
   5   Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
   6   Copyright (c) 2009-2013 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
  14 [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  15 [/ Generated from doxy/doxygen_output/xml/group__expand.xml]
  16 [section:expand_3_with_strategy expand (with strategy)]
  17
  18 '''<indexterm><primary>expand</primary></indexterm>'''
  19 Expands (with strategy)
  20
  21 [heading Synopsis]
  22 ``template<typename Box, typename Geometry, typename Strategy>
  23 void expand(Box & box, Geometry const & geometry, Strategy const & strategy)``
  24
  25 [heading Parameters]
  26
  27 [table
  28 [[Type] [Concept] [Name] [Description] ]
  29 [[Box &] [type of the box ] [box] [box to be expanded using another geometry, mutable ]]
  30 [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept geometry which envelope (bounding box) ]]
  31 [[Strategy const &] [Any type fulfilling a expand Strategy Concept ] [strategy] [The strategy which will be used for expand calculations will be added to the box]]
  32 ]
  33
  34
  35 [heading Header]
  36 Either
  37
  38 `#include <boost/geometry.hpp>`
  39
  40
  41 Or
  42
  43 `#include <boost/geometry/algorithms/expand.hpp>`
  44
  45 [include reference/algorithms/expand.qbk]
  46
  47
  48 [endsect]
  49
  50 [section:expand_2 expand]
  51
  52 '''<indexterm><primary>expand</primary></indexterm>'''
  53 Expands a box using the bounding box (envelope) of another geometry (box, point)
  54
  55 [heading Synopsis]
  56 ``template<typename Box, typename Geometry>
  57 void expand(Box & box, Geometry const & geometry)``
  58
  59 [heading Parameters]
  60
  61 [table
  62 [[Type] [Concept] [Name] [Description] ]
  63 [[Box &] [type of the box ] [box] [box to be expanded using another geometry, mutable ]]
  64 [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept geometry which envelope (bounding box) will be added to the box]]
  65 ]
  66
  67
  68 [heading Header]
  69 Either
  70
  71 `#include <boost/geometry.hpp>`
  72
  73
  74 Or
  75
  76 `#include <boost/geometry/algorithms/expand.hpp>`
  77
  78 [include reference/algorithms/expand.qbk]
  79
  80
  81 [endsect]
  82