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__assign.xml] 16[section:assign assign] 17 18'''<indexterm><primary>assign</primary></indexterm>''' 19Assigns one geometry to another geometry. 20 21[heading Description] 22The assign algorithm assigns one geometry, e.g. a BOX, to another geometry, e.g. a RING. This only works if it is possible and applicable. 23 24[heading Synopsis] 25``template<typename Geometry1, typename Geometry2> 26void assign(Geometry1 & geometry1, Geometry2 const & geometry2)`` 27 28[heading Parameters] 29 30[table 31[[Type] [Concept] [Name] [Description] ] 32[[Geometry1 &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept (target) ]] 33[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept (source)]] 34] 35 36 37[heading Header] 38Either 39 40`#include <boost/geometry.hpp>` 41 42 43Or 44 45`#include <boost/geometry/algorithms/assign.hpp>` 46 47[heading Example] 48[assign] [assign_output] 49 50[heading See also] 51* [link geometry.reference.algorithms.convert convert] 52 53 54[endsect] 55 56[section:assign_inverse assign_inverse] 57 58'''<indexterm><primary>assign_inverse</primary></indexterm>''' 59assign to a box inverse infinite 60 61[heading Description] 62The assign\u005finverse function initialize a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is a convenient starting point to collect the minimum bounding box of a geometry. 63 64[heading Synopsis] 65``template<typename Geometry> 66void assign_inverse(Geometry & geometry)`` 67 68[heading Parameters] 69 70[table 71[[Type] [Concept] [Name] [Description] ] 72[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept]] 73] 74 75 76[heading Header] 77Either 78 79`#include <boost/geometry.hpp>` 80 81 82Or 83 84`#include <boost/geometry/algorithms/assign.hpp>` 85 86[heading Example] 87[assign_inverse] [assign_inverse_output] 88 89[heading See also] 90* [link geometry.reference.algorithms.make.make_inverse make_inverse] 91 92 93[endsect] 94 95[section:assign_points assign_points] 96 97'''<indexterm><primary>assign_points</primary></indexterm>''' 98Assign a range of points to a linestring, ring or polygon. 99 100[heading Synopsis] 101``template<typename Geometry, typename Range> 102void assign_points(Geometry & geometry, Range const & range)`` 103 104[heading Parameters] 105 106[table 107[[Type] [Concept] [Name] [Description] ] 108[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 109[[Range const &] [Any type fulfilling a Range Concept where it range_value type fulfills the Point Concept ] [range] [A range containg points fulfilling range and point concepts]] 110] 111 112 113[heading Header] 114Either 115 116`#include <boost/geometry.hpp>` 117 118 119Or 120 121`#include <boost/geometry/algorithms/assign.hpp>` 122 123[heading Notes] 124[note Assign automatically clears the geometry before assigning (use append if you don't want that)] 125[heading Example] 126[assign_points] [assign_points_output] 127 128[heading See also] 129* [link geometry.reference.algorithms.append append] 130 131 132[endsect] 133 134[section:assign_values_3_2_coordinate_values assign_values (2 coordinate values)] 135 136'''<indexterm><primary>assign_values</primary></indexterm>''' 137Assign two coordinates to a geometry (usually a 2D point) 138 139[heading Synopsis] 140``template<typename Geometry, typename Type> 141void assign_values(Geometry & geometry, Type const & c1, Type const & c2)`` 142 143[heading Parameters] 144 145[table 146[[Type] [Concept] [Name] [Description] ] 147[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 148[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c1] [First coordinate (usually x-coordinate) ]] 149[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c2] [Second coordinate (usually y-coordinate)]] 150] 151 152 153[heading Header] 154Either 155 156`#include <boost/geometry.hpp>` 157 158 159Or 160 161`#include <boost/geometry/algorithms/assign.hpp>` 162 163[heading Example] 164[assign_2d_point] [assign_2d_point_output] 165 166[heading See also] 167* [link geometry.reference.algorithms.make.make_2_2_coordinate_values make] 168 169 170[endsect] 171 172[section:assign_values_4_3_coordinate_values assign_values (3 coordinate values)] 173 174'''<indexterm><primary>assign_values</primary></indexterm>''' 175Assign three values to a geometry (usually a 3D point) 176 177[heading Synopsis] 178``template<typename Geometry, typename Type> 179void assign_values(Geometry & geometry, Type const & c1, Type const & c2, 180 Type const & c3)`` 181 182[heading Parameters] 183 184[table 185[[Type] [Concept] [Name] [Description] ] 186[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 187[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c1] [First coordinate (usually x-coordinate) ]] 188[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c2] [Second coordinate (usually y-coordinate) ]] 189[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c3] [Third coordinate (usually z-coordinate)]] 190] 191 192 193[heading Header] 194Either 195 196`#include <boost/geometry.hpp>` 197 198 199Or 200 201`#include <boost/geometry/algorithms/assign.hpp>` 202 203[heading Example] 204[assign_3d_point] [assign_3d_point_output] 205 206[heading See also] 207* [link geometry.reference.algorithms.make.make_3_3_coordinate_values make] 208 209 210[endsect] 211 212[section:assign_values_5_4_coordinate_values assign_values (4 coordinate values)] 213 214'''<indexterm><primary>assign_values</primary></indexterm>''' 215Assign four values to a geometry (usually a box or segment) 216 217[heading Synopsis] 218``template<typename Geometry, typename Type> 219void assign_values(Geometry & geometry, Type const & c1, Type const & c2, 220 Type const & c3, Type const & c4)`` 221 222[heading Parameters] 223 224[table 225[[Type] [Concept] [Name] [Description] ] 226[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 227[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c1] [First coordinate (usually x1) ]] 228[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c2] [Second coordinate (usually y1) ]] 229[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c3] [Third coordinate (usually x2) ]] 230[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c4] [Fourth coordinate (usually y2)]] 231] 232 233 234[heading Header] 235Either 236 237`#include <boost/geometry.hpp>` 238 239 240Or 241 242`#include <boost/geometry/algorithms/assign.hpp>` 243 244 245[endsect] 246 247[section:assign_zero assign_zero] 248 249'''<indexterm><primary>assign_zero</primary></indexterm>''' 250assign zero values to a box, point 251 252[heading Description] 253The assign\u005fzero function initializes a 2D or 3D point or box with coordinates of zero 254 255[heading Synopsis] 256``template<typename Geometry> 257void assign_zero(Geometry & geometry)`` 258 259[heading Parameters] 260 261[table 262[[Type] [Concept] [Name] [Description] ] 263[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 264] 265 266 267[heading Header] 268Either 269 270`#include <boost/geometry.hpp>` 271 272 273Or 274 275`#include <boost/geometry/algorithms/assign.hpp>` 276 277 278[endsect] 279 280