mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-11 13:34:10 +00:00
Doc update, moved reference/* to generated/* and ref/* to reference/*
doxygen_xml2qbk escaping of underscores [SVN r69328]
This commit is contained in:
parent
3456835605
commit
9382f261fb
@ -69,6 +69,7 @@ ALIASES = qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
|
||||
tparam_second_point="second point type" \
|
||||
tparam_segment_point="segment point type" \
|
||||
tparam_strategy{1}="Any type fulfilling a \1 Strategy Concept" \
|
||||
tparam_strategy_overlay="Compound strategy for segment intersection" \
|
||||
param_box="A model of the specified Box Concept" \
|
||||
param_box_or_segment="A box modelling the specified Box Concept or segment modelling the specified Segment Concept" \
|
||||
param_geometry="A model of the specified concept" \
|
||||
|
@ -196,7 +196,7 @@ Or
|
||||
assign to a box inverse infinite
|
||||
|
||||
[heading Description]
|
||||
The assign_inverse 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.
|
||||
The 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.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
||||
@ -223,7 +223,7 @@ Or
|
||||
[assign_inverse] [assign_inverse_output]
|
||||
|
||||
[heading See also]
|
||||
* [link geometry.reference.algorithms.make.make_inverse make]
|
||||
* [link geometry.reference.algorithms.make.make_inverse make_inverse]
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -299,7 +299,7 @@ Or
|
||||
assign zero values to a box, point
|
||||
|
||||
[heading Description]
|
||||
The assign_zero function initializes a 2D or 3D point or box with coordinates of zero
|
||||
The assign\u005fzero function initializes a 2D or 3D point or box with coordinates of zero
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Class box: defines a box made of two describing points.
|
||||
|
||||
[heading Description]
|
||||
Box is always described by a min_corner() and a max_corner() point. If another rectangle is used, use linear_ring or polygon.
|
||||
Box is always described by a min\u005fcorner() and a max\u005fcorner() point. If another rectangle is used, use linear\u005fring or polygon.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Point>
|
@ -54,7 +54,7 @@ Or
|
||||
Calculates the buffer of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function make_buffer calculates the buffer (a polygon being the spatial point set collection within a specified maximum distance from a geometry) of a geometry. This version with the make_ prefix returns the buffer, and a template parameter must therefore be specified in the call..
|
||||
The free function make\u005fbuffer calculates the buffer (a polygon being the spatial point set collection within a specified maximum distance from a geometry) of a geometry. This version with the make\u005f prefix returns the buffer, and a template parameter must therefore be specified in the call..
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Output, typename Input, typename T, >
|
@ -89,7 +89,7 @@ Or
|
||||
Calculates the centroid of a geometry using the specified strategy.
|
||||
|
||||
[heading Description]
|
||||
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make_ prefix returns the centroid, and a template parameter must therefore be specified in the call.. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation.
|
||||
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make\u005f prefix returns the centroid, and a template parameter must therefore be specified in the call.. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Point, typename Geometry, typename Strategy>
|
||||
@ -129,7 +129,7 @@ Or
|
||||
Calculates the centroid of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make_ prefix returns the centroid, and a template parameter must therefore be specified in the call..
|
||||
The free function centroid calculates the geometric center (or: center of mass) of a geometry. This version with the make\u005f prefix returns the centroid, and a template parameter must therefore be specified in the call..
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Point, typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Centroid Exception.
|
||||
|
||||
[heading Description]
|
||||
The centroid_exception is thrown if the free centroid function is called with geometries for which the centroid cannot be calculated. For example: a linestring without points, a polygon without points, an empty multi-geometry.
|
||||
The centroid\u005fexception is thrown if the free centroid function is called with geometries for which the centroid cannot be calculated. For example: a linestring without points, a polygon without points, an empty multi-geometry.
|
||||
|
||||
[heading Synopsis]
|
||||
``class centroid_exception
|
@ -18,7 +18,7 @@
|
||||
Calculates the convex hull of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function convex_hull calculates the convex hull of a geometry.
|
||||
The free function convex\u005fhull calculates the convex hull of a geometry.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry1, typename Geometry2>
|
134
doc/generated/difference.qbk
Normal file
134
doc/generated/difference.qbk
Normal file
@ -0,0 +1,134 @@
|
||||
[/============================================================================
|
||||
Boost.Geometry (aka GGL, Generic Geometry Library)
|
||||
|
||||
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
|
||||
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
|
||||
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
|
||||
|
||||
Use, modification and distribution is subject to the Boost Software License,
|
||||
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
=============================================================================/]
|
||||
|
||||
|
||||
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
||||
[/ Generated from doxy/doxygen_output/xml/group__difference.xml]
|
||||
[section:difference difference]
|
||||
|
||||
|
||||
|
||||
[heading Description]
|
||||
Calculate the difference of two geometries
|
||||
|
||||
The free function difference calculates the spatial set theoretic difference of two geometries.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry1, typename Geometry2, typename Collection>
|
||||
void difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection]]
|
||||
]
|
||||
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/difference.hpp>`
|
||||
|
||||
[include ref/algorithms/difference.qbk]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:difference_inserter_3 difference_inserter]
|
||||
|
||||
|
||||
|
||||
[heading Description]
|
||||
Calculate the difference of two geometries
|
||||
|
||||
The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries. details\u005finserter{difference}
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
|
||||
OutputIterator difference_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [output iterator ] [out] [The output iterator, to which difference geometries are feeded ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/difference.hpp>`
|
||||
|
||||
[heading Example]
|
||||
[difference_inserter] [difference_inserter_output]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:difference_inserter_4_with_strategy difference_inserter (with strategy)]
|
||||
|
||||
|
||||
|
||||
[heading Description]
|
||||
Calculate the difference of two geometries using the specified strategy
|
||||
|
||||
The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries using the specified strategy. details\u005finserter{difference}
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
|
||||
OutputIterator difference_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out, Strategy const & strategy)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [output iterator ] [out] [The output iterator, to which difference geometries are feeded ]]
|
||||
[[Strategy const &] [Compound strategy for segment intersection ] [strategy] [The strategy which will be used for difference calculations ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/difference.hpp>`
|
||||
|
||||
|
||||
[endsect]
|
||||
|
@ -28,7 +28,7 @@ class strategy::distance::haversine
|
||||
[heading Template parameter(s)]
|
||||
[table
|
||||
[[Parameter] [Default] [Description]]
|
||||
[[typename Point1] [] [first point type ]]
|
||||
[[typename Point1] [] [point type ]]
|
||||
[[typename Point2] [Point1] [second point type ]]
|
||||
[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
|
||||
]
|
@ -31,7 +31,7 @@ class strategy::distance::projected_point
|
||||
[heading Template parameter(s)]
|
||||
[table
|
||||
[[Parameter] [Default] [Description]]
|
||||
[[typename Point] [] [point type ]]
|
||||
[[typename Point] [] [Any type fulfilling a Point Concept ]]
|
||||
[[typename PointOfSegment] [Point] [segment point type ]]
|
||||
[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
|
||||
[[typename Strategy] [pythagoras<Point, PointOfSegment, CalculationType>] [underlying point-point distance strategy ]]
|
@ -28,7 +28,7 @@ class strategy::distance::pythagoras
|
||||
[heading Template parameter(s)]
|
||||
[table
|
||||
[[Parameter] [Default] [Description]]
|
||||
[[typename Point1] [] [first point type ]]
|
||||
[[typename Point1] [] [point type ]]
|
||||
[[typename Point2] [Point1] [second point type ]]
|
||||
[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point]]
|
||||
]
|
@ -18,7 +18,7 @@
|
||||
Enumerates options for defining if polygons are open or closed.
|
||||
|
||||
[heading Description]
|
||||
The enumeration closure_selector describes options for if a polygon is open or closed. In a closed polygon the very first point (per ring) should be equal to the very last point. The specific closing property of a polygon type is defined by the closure metafunction. The closure metafunction defines a value, which is one of the values enumerated in the closure_selector
|
||||
The enumeration closure\u005fselector describes options for if a polygon is open or closed. In a closed polygon the very first point (per ring) should be equal to the very last point. The specific closing property of a polygon type is defined by the closure metafunction. The closure metafunction defines a value, which is one of the values enumerated in the closure\u005fselector
|
||||
|
||||
[heading Synopsis]
|
||||
``enum closure_selector {open = 0, closed = 1, closure_undertermined = -1};``
|
||||
@ -47,7 +47,7 @@ The enumeration closure_selector describes options for if a polygon is open or c
|
||||
Enumerates options for the order of points within polygons.
|
||||
|
||||
[heading Description]
|
||||
The enumeration order_selector describes options for the order of points within a polygon. Polygons can be ordered either clockwise or counterclockwise. The specific order of a polygon type is defined by the point_order metafunction. The point_order metafunction defines a value, which is one of the values enumerated in the order_selector
|
||||
The enumeration order\u005fselector describes options for the order of points within a polygon. Polygons can be ordered either clockwise or counterclockwise. The specific order of a polygon type is defined by the point\u005forder metafunction. The point\u005forder metafunction defines a value, which is one of the values enumerated in the order\u005fselector
|
||||
|
||||
[heading Synopsis]
|
||||
``enum order_selector {clockwise = 1, counterclockwise = 2, order_undetermined = 0};``
|
@ -42,6 +42,9 @@ Or
|
||||
|
||||
`#include <boost/geometry/algorithms/envelope.hpp>`
|
||||
|
||||
[heading Example]
|
||||
[envelope] [envelope_output]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
@ -50,7 +53,7 @@ Or
|
||||
Calculates the envelope of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function make_envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the make_ prefix returns the envelope, and a template parameter must therefore be specified in the call.
|
||||
The free function make\u005fenvelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the make\u005f prefix returns the envelope, and a template parameter must therefore be specified in the call.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Box, typename Geometry>
|
||||
@ -66,7 +69,7 @@ Box make_envelope(Geometry const & geometry)``
|
||||
|
||||
|
||||
[heading Returns]
|
||||
The calculated envelope
|
||||
The calculated envelope
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
@ -77,6 +80,9 @@ Or
|
||||
|
||||
`#include <boost/geometry/algorithms/envelope.hpp>`
|
||||
|
||||
[heading Example]
|
||||
[make_envelope] [make_envelope_output]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
@ -46,7 +46,7 @@ Or
|
||||
|
||||
[section:exterior_ring_1 exterior_ring]
|
||||
|
||||
Function to get the exterior_ring ring of a polygon.
|
||||
Function to get the exterior\u005fring ring of a polygon.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Polygon, >
|
@ -53,7 +53,7 @@ Or
|
||||
Calculate the intersection of two geometries.
|
||||
|
||||
[heading Description]
|
||||
The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
The free function intersection\u005finserter calculates the spatial set theoretic intersection of two geometries. This version with the \u005finserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
|
||||
@ -86,7 +86,7 @@ The output iterator
|
||||
Calculate the intersection of two geometries using the specified strategy.
|
||||
|
||||
[heading Description]
|
||||
The free function intersection_inserter calculates the spatial set theoretic intersection of two geometries using the specified strategy. This version with the _inserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
The free function intersection\u005finserter calculates the spatial set theoretic intersection of two geometries using the specified strategy. This version with the \u005finserter suffix outputs the intersection to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
|
||||
@ -100,7 +100,7 @@ OutputIterator intersection_inserter(Geometry1 const & geometry1, Geometry2 cons
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [A valid output iterator type, accepting geometries of Point, LineString or Polygon Concept ] [out] [The output iterator, to which intersection geometries are feeded ]]
|
||||
[[Strategy const &] [Compound strategy for intersection ] [strategy] [The strategy ]]
|
||||
[[Strategy const &] [Compound strategy for segment intersection ] [strategy] [The strategy which will be used for intersection calculations ]]
|
||||
]
|
||||
|
||||
|
@ -135,7 +135,7 @@ Or
|
||||
Construct a box with inverse infinite coordinates.
|
||||
|
||||
[heading Description]
|
||||
The make_inverse function initializes a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is useful e.g. in combination with the combine function, to determine the bounding box of a series of geometries.
|
||||
The make\u005finverse function initializes a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is useful e.g. in combination with the combine function, to determine the bounding box of a series of geometries.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
||||
@ -165,7 +165,7 @@ Or
|
||||
[make_inverse] [make_inverse_output]
|
||||
|
||||
[heading See also]
|
||||
* [link geometry.reference.algorithms.assign.assign_inverse assign]
|
||||
* [link geometry.reference.algorithms.assign.assign_inverse assign_inverse]
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -175,7 +175,7 @@ Or
|
||||
Construct a geometry with its coordinates initialized to zero.
|
||||
|
||||
[heading Description]
|
||||
The make_zero function initializes a 2D or 3D point or box with coordinates of zero
|
||||
The make\u005fzero function initializes a 2D or 3D point or box with coordinates of zero
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Calculates the number of geometries of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function num_geometries calculates the number of geometries of a geometry.
|
||||
The free function num\u005fgeometries calculates the number of geometries of a geometry.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Calculates the number of interior rings of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function num_interior_rings calculates the number of interior rings of a geometry.
|
||||
The free function num\u005finterior\u005frings calculates the number of interior rings of a geometry.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Calculates the number of points of a geometry.
|
||||
|
||||
[heading Description]
|
||||
The free function num_points calculates the number of points of a geometry.
|
||||
The free function num\u005fpoints calculates the number of points of a geometry.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry>
|
@ -18,7 +18,7 @@
|
||||
Macro to register a 2D point type.
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_2D registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_2D(Point, CoordinateType, CoordinateSystem, Field0, Field1)``
|
||||
@ -48,7 +48,7 @@ The macro BOOST_GEOMETRY_REGISTER_POINT_2D registers a two-dimensional point typ
|
||||
Macro to register a 2D point type (const version).
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_2D_CONST registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The const version registers only read access to the fields, the point type is therefore read-only
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D\u005fCONST registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The const version registers only read access to the fields, the point type is therefore read-only
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_2D_CONST(Point, CoordinateType, CoordinateSystem, Field0, Field1)``
|
||||
@ -76,7 +76,7 @@ The macro BOOST_GEOMETRY_REGISTER_POINT_2D_CONST registers a two-dimensional poi
|
||||
Macro to register a 2D point type (having separate get/set methods).
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D\u005fGET\u005fSET registers a two-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET(Point, CoordinateType, CoordinateSystem, Get0, Get1, Set0, Set1)``
|
||||
@ -106,7 +106,7 @@ The macro BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET registers a two-dimensional p
|
||||
Macro to register a 3D point type.
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_3D registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_3D(Point, CoordinateType, CoordinateSystem, Field0, Field1, Field2)``
|
||||
@ -135,7 +135,7 @@ The macro BOOST_GEOMETRY_REGISTER_POINT_3D registers a three-dimensional point t
|
||||
Macro to register a 3D point type (const version).
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_3D_CONST registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The const version registers only read access to the fields, the point type is therefore read-only
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D\u005fCONST registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The const version registers only read access to the fields, the point type is therefore read-only
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_3D_CONST(Point, CoordinateType, CoordinateSystem, Field0, Field1, Field2)``
|
||||
@ -164,7 +164,7 @@ The macro BOOST_GEOMETRY_REGISTER_POINT_3D_CONST registers a three-dimensional p
|
||||
Macro to register a 3D point type (having separate get/set methods).
|
||||
|
||||
[heading Description]
|
||||
The macro BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
|
||||
The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f3D\u005fGET\u005fSET registers a three-dimensional point type such that it is recognized by Boost.Geometry and that Boost.Geometry functionality can used with the specified point type. The get/set version registers get and set methods separately and can be used for classes with protected member variables and get/set methods to change coordinates
|
||||
|
||||
[heading Synopsis]
|
||||
``#define BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET(Point, CoordinateType, CoordinateSystem, Get0, Get1, Get2, Set0, Set1, Set2)``
|
@ -18,7 +18,7 @@
|
||||
Implements the simplify algorithm.
|
||||
|
||||
[heading Description]
|
||||
The douglas_peucker strategy simplifies a linestring, ring or vector of points using the well-known Douglas-Peucker algorithm. For the algorithm, see for example:
|
||||
The douglas\u005fpeucker strategy simplifies a linestring, ring or vector of points using the well-known Douglas-Peucker algorithm. For the algorithm, see for example:
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Point, typename PointDistanceStrategy>
|
125
doc/generated/sym_difference.qbk
Normal file
125
doc/generated/sym_difference.qbk
Normal file
@ -0,0 +1,125 @@
|
||||
[/============================================================================
|
||||
Boost.Geometry (aka GGL, Generic Geometry Library)
|
||||
|
||||
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
|
||||
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
|
||||
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
|
||||
|
||||
Use, modification and distribution is subject to the Boost Software License,
|
||||
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
=============================================================================/]
|
||||
|
||||
|
||||
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
|
||||
[/ Generated from doxy/doxygen_output/xml/group__sym__difference.xml]
|
||||
[section:sym_difference sym_difference]
|
||||
|
||||
Calculate the symmetric difference of two geometries.
|
||||
|
||||
[heading Description]
|
||||
The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry1, typename Geometry2, typename Collection>
|
||||
void sym_difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[Collection &] [output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc ] [output_collection] [the output collection]]
|
||||
]
|
||||
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/sym_difference.hpp>`
|
||||
|
||||
[include ref/algorithms/sym_difference.qbk]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:sym_difference_inserter_3 sym_difference_inserter]
|
||||
|
||||
Calculate the symmetric difference of two geometries.
|
||||
|
||||
[heading Description]
|
||||
The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries This version with the \u005finserter suffix outputs the sym\u005fdifference to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
|
||||
OutputIterator sym_difference_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [] [out] [The output iterator, to which difference geometries are feeded ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/sym_difference.hpp>`
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:sym_difference_inserter_4_with_strategy sym_difference_inserter (with strategy)]
|
||||
|
||||
Calculate the symmetric difference of two geometries using the specified strategy.
|
||||
|
||||
[heading Description]
|
||||
The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries using the specified strategy. details\u005finserter{sym\u005fdifference}
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
|
||||
OutputIterator sym_difference_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out, Strategy const & strategy)``
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
[table
|
||||
[[Type] [Concept] [Name] [Description] ]
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [] [out] [The output iterator, to which difference geometries are feeded ]]
|
||||
[[Strategy const &] [Compound strategy for segment intersection ] [strategy] [The strategy which will be used for difference calculations ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
|
||||
`#include <boost/geometry/geometry.hpp>`
|
||||
|
||||
Or
|
||||
|
||||
`#include <boost/geometry/algorithms/sym_difference.hpp>`
|
||||
|
||||
|
||||
[endsect]
|
||||
|
@ -17,6 +17,9 @@
|
||||
|
||||
Combines two geometries which each other.
|
||||
|
||||
[heading Description]
|
||||
The free function union calculates the spatial set theoretic union of two geometries.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename Geometry1, typename Geometry2, typename Collection>
|
||||
void union_(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
|
||||
@ -47,7 +50,12 @@ Or
|
||||
|
||||
[section:union_inserter_3 union_inserter]
|
||||
|
||||
Combines two geometries which each other.
|
||||
|
||||
|
||||
[heading Description]
|
||||
Calculate the union of two geometries
|
||||
|
||||
The free function union\u005finserter calculates the spatial set theoretic union of two geometries. This version with the \u005finserter suffix outputs the union to an output iterator, and a template parameter must therefore be specified in the call.
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
|
||||
@ -60,12 +68,12 @@ OutputIterator union_inserter(Geometry1 const & geometry1, Geometry2 const & geo
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [output iterator ] [out] [the output iterator, outputting polygons ]]
|
||||
[[OutputIterator] [output iterator ] [out] [The output iterator, to which union geometries are feeded ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
the output iterator
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
||||
@ -79,9 +87,14 @@ Or
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:union_inserter_4 union_inserter]
|
||||
[section:union_inserter_4_with_strategy union_inserter (with strategy)]
|
||||
|
||||
Combines two geometries which each other.
|
||||
|
||||
|
||||
[heading Description]
|
||||
Calculate the union of two geometries using the specified strategy
|
||||
|
||||
The free function union\u005finserter calculates the spatial set theoretic union of two geometries using the specified strategy. details\u005finserter{union}
|
||||
|
||||
[heading Synopsis]
|
||||
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
|
||||
@ -94,13 +107,13 @@ OutputIterator union_inserter(Geometry1 const & geometry1, Geometry2 const & geo
|
||||
[[GeometryOut] [output geometry type, must be specified ] [ - ] [Must be specified]]
|
||||
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
|
||||
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
|
||||
[[OutputIterator] [output iterator ] [out] [the output iterator, outputting polygons ]]
|
||||
[[Strategy const &] [compound strategy for intersection ] [strategy] [the strategy ]]
|
||||
[[OutputIterator] [output iterator ] [out] [The output iterator, to which union geometries are feeded ]]
|
||||
[[Strategy const &] [Compound strategy for segment intersection ] [strategy] [The strategy which will be used for union calculations ]]
|
||||
]
|
||||
|
||||
|
||||
[heading Returns]
|
||||
the output iterator
|
||||
The output iterator
|
||||
|
||||
[heading Header]
|
||||
Either
|
@ -28,7 +28,7 @@ class strategy::within::crossings_multiply
|
||||
[heading Template parameter(s)]
|
||||
[table
|
||||
[[Parameter] [Default] [Description]]
|
||||
[[typename Point] [] [point type ]]
|
||||
[[typename Point] [] [Any type fulfilling a Point Concept ]]
|
||||
[[typename PointOfSegment] [Point] [segment point type ]]
|
||||
[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
|
||||
]
|
@ -28,7 +28,7 @@ class strategy::within::franklin
|
||||
[heading Template parameter(s)]
|
||||
[table
|
||||
[[Parameter] [Default] [Description]]
|
||||
[[typename Point] [] [point type ]]
|
||||
[[typename Point] [] [Any type fulfilling a Point Concept ]]
|
||||
[[typename PointOfSegment] [Point] [segment point type ]]
|
||||
[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]]
|
||||
]
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user