Doc update and added to 3 list-files (maintainers.txt, libraries.htm, status/Jamfile.v2)

[SVN r67518]
This commit is contained in:
Barend Gehrels 2010-12-31 14:29:53 +00:00
parent 508064d408
commit 6f56c303cb
39 changed files with 231 additions and 28322 deletions

View File

@ -13,13 +13,14 @@
[version 1.0]
[authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz]]
[copyright 2010 Barend Gehrels, Bruno Lalande, Mateusz Loskot]
[purpose A generic library for geometry]
[purpose Documentation of Boost.Geometry library]
[license
Distributed under 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])
]
[id geometry]
[category geometry]
]
[/Behavior]
@ -57,17 +58,14 @@
[*In progress]
[import snippets/qbk_1.cpp]
[import snippets/qbk_2.cpp]
[import snippets/qbk_3.cpp]
[import snippets/qbk_4.cpp]
[import snippets/qbk_5.cpp]
[include introduction.qbk]
[include quickstart.qbk]
[include matrix.qbk]
[include reference.qbk]

View File

@ -41,24 +41,24 @@ os.system(cmd % ("group__reverse", "reverse"))
os.system(cmd % ("group__simplify", "simplify"))
os.system(cmd % ("group__unique", "unique"))
# os.system(cmd % ("group__access.xml", "access"))
# os.system(cmd % ("group__combine.xml", "combine"))
# os.system(cmd % ("group__convert.xml", "convert"))
os.system(cmd % ("group__difference.xml", "difference"))
# os.system(cmd % ("group__disjoint.xml", "disjoint"))
# os.system(cmd % ("group__access", "access"))
os.system(cmd % ("group__combine", "combine"))
os.system(cmd % ("group__convert", "convert"))
os.system(cmd % ("group__difference", "difference"))
os.system(cmd % ("group__disjoint", "disjoint"))
os.system(cmd % ("group__distance", "distance"))
# os.system(cmd % ("group__equals.xml", "equals"))
# os.system(cmd % ("group__for__each.xml", "for_each"))
os.system(cmd % ("group__equals", "equals"))
os.system(cmd % ("group__for__each", "for_each"))
os.system(cmd % ("group__intersection", "intersection"))
os.system(cmd % ("group__intersects", "intersects"))
os.system(cmd % ("group__overlaps.xml", "overlaps"))
os.system(cmd % ("group__sym__difference.xml", "sym_difference"))
os.system(cmd % ("group__transform.xml", "transform"))
os.system(cmd % ("group__union.xml", "union"))
os.system(cmd % ("group__overlaps", "overlaps"))
os.system(cmd % ("group__sym__difference", "sym_difference"))
os.system(cmd % ("group__transform", "transform"))
os.system(cmd % ("group__union", "union"))
os.system(cmd % ("group__within", "within"))
os.system(cmd % ("group__register", "register"))
@ -66,7 +66,7 @@ os.system(cmd % ("group__register", "register"))
os.system(cmd % ("classboost_1_1geometry_1_1point", "point"))
os.system(cmd % ("classboost_1_1geometry_1_1point__xy", "point_xy"))
os.system(cmd % ("classboost_1_1geometry_1_1concept_1_1_point.xml", "concept_point"))
os.system(cmd % ("classboost_1_1geometry_1_1concept_1_1_point", "concept_point"))
os.system(cmd % ("structboost_1_1geometry_1_1closing__iterator", "closing_iterator"))

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

@ -1,60 +0,0 @@
# doc/quickbook/Jamfile.v2 builds Quickbook documentation for Geometry library
#
# Copyright (c) 2009 Mateusz Loskot <mateusz@loskot.net>
# 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)
#
# TODO: when moved to boot --mloskot
#project boost/libs/geometry/doc ;
import boostbook : boostbook ;
using quickbook ;
using doxygen ;
path-constant here : . ;
path-constant images_location : html ;
xml geometry
:
geometry.qbk
:
;
boostbook standalone
:
geometry
:
<xsl:param>chapter.autolabel=0
<xsl:param>chunk.section.depth=8
<xsl:param>chunk.first.sections=1
<xsl:param>toc.section.depth=2
<xsl:param>toc.max.depth=1
<xsl:param>generate.section.toc.level=1
<xsl:param>generate.toc="chapter nop section nop"
<xsl:param>root.filename=boost_geometry
<xsl:param>boost.root="../../../.."
<xsl:param>html.stylesheet=http://mateusz.loskot.net/tmp/ggl/boostbook.css
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
;
#boostbook quickbook
# :
# geometry.qbk
# :
# # TODO: These paths assume Boost.Geometry lives in Boost tree
# <xsl:param>boost.root=../../../..
# <xsl:param>boost.libraries=../../../libraries.htm
# TODO Use local path ../../../../doc/html/boostbook.css or similar
# but temporarily link to online CSS - hmm, does not work, using private
# copy of CSS is in quickbook/html/boostbook.css
# <xsl:param>html.stylesheet=http://www.boost.org/doc/libs/1_41_0/doc/html/boostbook.css
# TODO: Tweak these parameters
# <xsl:param>chunk.section.depth=4
# <xsl:param>chunk.first.sections=1
# <xsl:param>toc.section.depth=2
# <xsl:param>toc.max.depth=2
# <xsl:param>generate.section.toc.level=4
# <format>html:<xsl:param>admon.graphics.path=images/
# <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/geometry/doc/html
# <format>pdf:<xsl:param>img.src.path=$(images_location)/
# ;

View File

@ -1,89 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section area]
['TODO: type and function names to be inter-linked --mloskot]
[heading Description]
Calculate area of a geometry.
The area algorithm calculates the surface area of all geometries having a surface, namely
box, polygon, ring, multipolygon. The units are the square of the units used for the points
defining the surface. If subject geometry is defined in meters, then area is calculated
in square meters.
The area calculation can be done in all three common coordinate systems, Cartesian, Spherical
and Geographic as well.
[heading Synopsis]
namespace boost { namespace geometry {
template<typename Geometry>
typename area_result<Geometry>::type area(Geometry const &geometry)
template<typename Geometry, typename Strategy>
Strategy::return_type area(Geometry const &geometry, Strategy const &strategy)
template<typename Geometry>
typename area_result<Geometry>::type area(Geometry const &geometry)
}}
[table Template Parameters
[[Parameter] [Requirement] [Description]]
[[`Geometry`] [Models of one of geometry __concepts__] []]
[[`Strategy`] [Models of AreaStrategy] []]
]
[table Parameters
[[Parameter] [Requirement] [Description]]
[[`geometry`] [Shall form a valid geometry]
[Polygon should be closed and according to specified orientation (clockwise or counter-clockwise)]]
[[`strategy`] [['TODO]]
[Specifies algorithm of area calculation, especially useful for spherical areas where number
of approaches are possible]]
]
[table Expression Semantics
[[Expression] [Return Type] [Description]]
[[__area__(geometry);] [`area_result<Geometry>::type`]
[Calculates area of polygon, ring, box using default area strategy provided for __wiki_cs_cartesian__ and __wiki_cs_spherical__]]
[[__area__(geometry,strategy);] [`Strategy::return_type`]
[Calculates area of polygon, ring, box using specified area strategy]]
]
[heading Complexity]
[table
[[Notation] [Name] [Notes]]
[[`O(n)`] [__wiki_complex_linear__] []]
]
Benchmark example: calculation of `2776 * 1000` areas done in 0.11 seconds (see [@http://trac.osgeo.org/ggl/wiki/Performance Performance] earticle on the Wiki).
[heading Header]
#include <boost/geometry/algorithms/area.hpp>
[heading Example]
using namespace boost::geometry;
polygon<boost::geometry::point_xy<double> > poly;
read_wkt("POLYGON((0 0,0 7,4 2,2 0,0 0))", poly);
std::cout << "Polygon area is " << area(poly) << " square units" << std::endl;
// Other coordinate system, spherical or geographic (extension)
polygon<point<float, 2, cs::spherical<degree> > > sph_poly;
read_wkt("POLYGON((0 0,0 45,45 0,0 0))", sph_poly);
std::cout << "Area is " << area(sph_poly) << " on unit sphere " << std::endl;
[endsect] [/ end of section area]

View File

@ -1,32 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section:distance distance (?)]
['TODO: distance algorithm...]
[heading Description]
['TODO: this is distance algorithm...]
[heading Synopsis]
['TODO: distance parameters...]
[heading Complexity]
['TODO: distance complexity...]
[heading Header]
['TODO: are public headers...]
[heading Example]
['TODO: distance example...]
[heading Notes]
['TODO: distance notes...]
[endsect] [/ end of section distance]

View File

@ -1,16 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section Algorithms]
[include algorithm_area.qbk]
[include algorithm_distance.qbk]
[endsect] [/ end of section Algorithms]

View File

@ -1,15 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section:cs Coordinate Systems (?)]
['TODO: long story about coordinate systems...]
['TODO: end of long story about coordinate systems...]
[endsect] [/ end of section Coordinate Systems]

View File

@ -1,17 +0,0 @@
#!/usr/bin/perl -w
# Copyright (c) 2003-2010 Christopher M. Kohlhoff (chris at kohlhoff dot com)
#
# Distributed under 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)
use strict;
system("doxygen reference.doxygen");
chdir("xml");
system("xsltproc combine.xslt index.xml > all.xml");
chdir("..");
system("xsltproc reference.xsl xml/all.xml > reference.qbk");
#system("rm -rf xml");
#system("rm -rf xml reference.tags");

View File

@ -1,116 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[article Boost.Geometry
[quickbook 1.4]
[version 1.0]
[authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz]]
[copyright 2010 Barend Gehrels, Bruno Lalande, Mateusz Loskot]
[purpose Documentation of Boost.Geometry library]
[license
Distributed under 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])
]
[id geometry]
[dirname /home/mloskot/dev/ggl/_svn/trunk]
[category geometry]
]
[/ MACROS ////////////////////////////////////////////////////////////////////////////////////////]
[/ External link macros ///////////////////////////////////////////////////////////////////////////]
[def __ggl__ [@http://trac.osgeo.org/ggl/ Generic Geometry Library]]
[def __ogc__ [@http://www.opengeospatial.org/ OGC]]
[def __cln__ [@http://www.ginac.de/CLN/ CLN]]
[def __gmp__ [@http://gmplib.org/ GMP]]
[def __stl__ [@http://www.sgi.com/tech/stl/ STL]]
[def __stlport__ [@http://stlport.sourceforge.net/ STLPort]]
[def __gcc__ [@http://gcc.gnu.org/ GNU C++]]
[def __msvc__ [@http://msdn.microsoft.com/en-us/visualc/ Microsoft Visual C++]]
[def __msvs__ [@http://msdn.microsoft.com/en-us/vstudio/ Microsoft Visual Studio]]
[def __msvs_express__ [@http://msdn.microsoft.com/express/ Microsoft Visual Studio Express]]
[def __geodan__ [@http://www.geodan.com/ Geodan]]
[def __mloskot__ [@http://mateusz.loskot.net/ Mateusz Loskot]]
[/ Boost general]
[def __boost__ [@http://www.boost.org/ Boost]]
[def __boost_cpp_lib__ [@http://www.boost.org/ Boost C++ Libraries]]
[def __boost_gs__ [@http://www.boost.org/doc/libs/release/more/getting_started/index.html Boost Getting Started]]
[def __boost_gtp__ [@http://www.boost.org/community/generic_programming.html Generic Programming Techniques]]
[def __boost_bb__ [@http://www.boost.org/doc/tools/build/index.html Boost Build]]
[/ Boost libraries]
[def __boost_array__ [@http://www.boost.org/libs/array/ Boost Array]]
[def __boost_graph__ [@http://www.boost.org/libs/graph/ Boost Graph Library (BGL)]]
[def __boost_concept__ [@http://www.boost.org/libs/concept_check/ Boost Concept Check Library (BCCL)]]
[def __boost_conversion__ [@http://www.boost.org/libs/conversion/ Boost Conversion]]
[def __boost_geometry__ [@http://trac.osgeo.org/ggl/ Boost Geometry]]
[def __boost_gil__ [@http://www.boost.org/libs/gil/ Boost GIL]]
[def __boost_iterator__ [@http://www.boost.org/libs/iterator/ Boost Iterator]]
[def __boost_mpl__ [@http://www.boost.org/libs/gil/ Boost Metaprogramming Library (MPL)]]
[def __boost_numericadaptor__ [@http://svn.boost.org/svn/boost/sandbox/numeric_adaptor/ Boost Numeric Adaptor]]
[def __boost_numericconv__ [@http://www.boost.org/libs/numeric/conversion/ Boost Numeric Conversion]]
[def __boost_range__ [@http://www.boost.org/libs/range/ Boost Range]]
[def __boost_smart_ptr__ [@http://www.boost.org/libs/smart_ptr/ Boost Smart Pointers]]
[def __boost_staticassert__ [@http://www.boost.org/libs/static_assert/ Boost Static Assert]]
[def __boost_stringalgo__ [@http://www.boost.org/libs/algorithm/string/ Boost String Algorithms]]
[def __boost_test__ [@http://www.boost.org/libs/test/ Boost Test]]
[def __boost_timer__ [@http://www.boost.org/libs/timer/ Boost Timer]]
[def __boost_traits__ [@http://www.boost.org/libs/type_traits/ Boost TypeTraits]]
[def __boost_tokenizer__ [@http://www.boost.org/libs/tokenizer/ Boost Tokenizer]]
[def __boost_tuple__ [@http://www.boost.org/libs/tuple/ Boost Tuple]]
[def __boost_ublas__ [@http://www.boost.org/libs/numeric/ublas/ Boost uBLAS]]
[/ Wikipedia]
[def __wiki_cs_cartesian__ [@http://en.wikipedia.org/wiki/Cartesian_coordinate_system Cartesian coordinate system]]
[def __wiki_cs_spherical__ [@http://en.wikipedia.org/wiki/Spherical_coordinate_system Spherical coordinate system]]
[def __wiki_cs_geographic__ [@http://en.wikipedia.org/wiki/Geographic_coordinate_system Geographic coordinate system]]
[def __wiki_demorgan_laws__ [@http://en.wikipedia.org/wiki/De_Morgan%27s_laws De Morgan's laws]]
[def __wiki_set_algebra__ [@http://en.wikipedia.org/wiki/Algebra_of_sets Algebra of Sets]]
[def __wiki_set_law_complements__ [@http://en.wikipedia.org/wiki/Algebra_of_sets#Some_additional_laws_for_complements Laws for Complements]]
[def __wiki_set_theory__ [@http://en.wikipedia.org/wiki/Set_(mathematics) Set Theory]]
[def __wiki_sfinae__ [@http://en.wikipedia.org/wiki/Substitution_failure_is_not_an_error SFINAE]]
[def __wiki_std__ [@http://en.wikipedia.org/wiki/C%2B%2B_Standard_Library C++ Standard Library]]
[def __wiki_weiler_atherton__ [@http://en.wikipedia.org/wiki/Weiler-Atherton_clipping_algorithm Weiler-Atherton clipping algorithm]]
[def __wiki_complex_linear__ [@http://en.wikipedia.org/wiki/Linear_time#Linear_time Linear time]]
[/ Images macros //////////////////////////////////////////////////////////////////////////////////]
[def __img_quickstart_output__ [$./images/quickstart_output.png]]
[def __img_set_a_ac__ [$./images/set_a_ac.png]]
[def __img_set_adapt_turns__ [$./images/set_adapt_turns.png]]
[def __img_set_int_right_union_left__ [$./images/set_int_right_union_left.png]]
[/ Internal link macros ///////////////////////////////////////////////////////////////////////////]
[/ Concepts and models]
[def __concepts__ [link geometry.reference.geometries.concepts concepts]]
[def __concept_point__ [link geometry.reference.geometries.concepts.point Point]]
[def __concept_constpoint__ [link geometry.reference.geometries.concepts.constpoint ConstPoint]]
[def __model_point__ [link geometry.reference.geometries.types.points.point point]]
[def __model_point_xy__ [link geometry.reference.geometries.types.points.point_xy point_xy]]
[/ Arithmetic]
[def __area__ [link geometry.reference.algorithms.area area]]
[def __distance__ [link geometry.reference.algorithms.distance distance]]
[def __add_point__ [link geometry.reference.arithmetic.add_point add_point]]
[/ Character and entities macrods /////////////////////////////////////////////////////////////////]
[def __set_complement__ c]
[def __set_difference__ \\]
[def __set_symdifference__ ∆] [/ &#8710;]
[def __set_intersect__ ∩] [/ &#8745;]
[def __set_union__ ] [/ &#8746;]
[/ TEMPLATES /////////////////////////////////////////////////////////////////////////////////////]
[template mdash[] '''&mdash; ''']
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
[/ Content starts here ////////////////////////////////////////////////////////////////////////////]
This is the documentation of the newest version of __ggl__ (current Subversion trunk).
[link boost_geometry.reference Reference]
[include reference.qbk]

View File

@ -1,598 +0,0 @@
/*=============================================================================
Copyright (c) 2004 Joel de Guzman
http://spirit.sourceforge.net/
Distributed under the Boost Software License, Version 1.0. (See accompany-
ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
=============================================================================*/
/*=============================================================================
Body defaults
=============================================================================*/
body
{
margin: 1em;
font-family: sans-serif;
}
/*=============================================================================
Paragraphs
=============================================================================*/
p
{
text-align: left;
font-size: 10pt;
line-height: 1.15;
}
/*=============================================================================
Program listings
=============================================================================*/
/* Code on paragraphs */
p tt.computeroutput
{
font-size: 9pt;
}
pre.synopsis
{
font-size: 90%;
margin: 1pc 4% 0pc 4%;
padding: 0.5pc 0.5pc 0.5pc 0.5pc;
}
.programlisting,
.screen
{
font-size: 9pt;
display: block;
margin: 1pc 4% 0pc 4%;
padding: 0.5pc 0.5pc 0.5pc 0.5pc;
}
/* Program listings in tables don't get borders */
td .programlisting,
td .screen
{
margin: 0pc 0pc 0pc 0pc;
padding: 0pc 0pc 0pc 0pc;
}
/*=============================================================================
Headings
=============================================================================*/
h1, h2, h3, h4, h5, h6
{
text-align: left;
margin: 1em 0em 0.5em 0em;
font-weight: bold;
}
h1 { font: 140% }
h2 { font: bold 140% }
h3 { font: bold 130% }
h4 { font: bold 120% }
h5 { font: italic 110% }
h6 { font: italic 100% }
/* Top page titles */
title,
h1.title,
h2.title
h3.title,
h4.title,
h5.title,
h6.title,
.refentrytitle
{
font-weight: bold;
margin-bottom: 1pc;
}
h1.title { font-size: 140% }
h2.title { font-size: 140% }
h3.title { font-size: 130% }
h4.title { font-size: 120% }
h5.title { font-size: 110% }
h6.title { font-size: 100% }
.section h1
{
margin: 0em 0em 0.5em 0em;
font-size: 140%;
}
.section h2 { font-size: 140% }
.section h3 { font-size: 130% }
.section h4 { font-size: 120% }
.section h5 { font-size: 110% }
.section h6 { font-size: 100% }
/* Code on titles */
h1 tt.computeroutput { font-size: 140% }
h2 tt.computeroutput { font-size: 140% }
h3 tt.computeroutput { font-size: 130% }
h4 tt.computeroutput { font-size: 130% }
h5 tt.computeroutput { font-size: 130% }
h6 tt.computeroutput { font-size: 130% }
/*=============================================================================
Author
=============================================================================*/
h3.author
{
font-size: 100%
}
/*=============================================================================
Lists
=============================================================================*/
li
{
font-size: 10pt;
line-height: 1.3;
}
/* Unordered lists */
ul
{
text-align: left;
}
/* Ordered lists */
ol
{
text-align: left;
}
/*=============================================================================
Links
=============================================================================*/
a
{
text-decoration: none; /* no underline */
}
a:hover
{
text-decoration: underline;
}
/*=============================================================================
Spirit style navigation
=============================================================================*/
.spirit-nav
{
text-align: right;
}
.spirit-nav a
{
color: white;
padding-left: 0.5em;
}
.spirit-nav img
{
border-width: 0px;
}
/*=============================================================================
Copyright footer
=============================================================================*/
.copyright-footer
{
text-align: right;
font-size: 70%;
}
.copyright-footer p
{
text-align: right;
font-size: 80%;
}
/*=============================================================================
Table of contents
=============================================================================*/
.toc
{
margin: 1pc 4% 0pc 4%;
padding: 0.1pc 1pc 0.1pc 1pc;
font-size: 80%;
line-height: 1.15;
}
.boost-toc
{
float: right;
padding: 0.5pc;
}
/* Code on toc */
.toc .computeroutput { font-size: 120% }
/*=============================================================================
Tables
=============================================================================*/
.table-title,
div.table p.title
{
margin-left: 4%;
padding-right: 0.5em;
padding-left: 0.5em;
}
.informaltable table,
.table table
{
width: 92%;
margin-left: 4%;
margin-right: 4%;
}
div.informaltable table,
div.table table
{
padding: 4px;
}
/* Table Cells */
div.informaltable table tr td,
div.table table tr td
{
padding: 0.5em;
text-align: left;
font-size: 9pt;
}
div.informaltable table tr th,
div.table table tr th
{
padding: 0.5em 0.5em 0.5em 0.5em;
border: 1pt solid white;
font-size: 80%;
}
table.simplelist
{
width: auto !important;
margin: 0em !important;
padding: 0em !important;
border: none !important;
}
table.simplelist td
{
margin: 0em !important;
padding: 0em !important;
text-align: left !important;
font-size: 9pt !important;
border: none !important;
}
/*=============================================================================
Blurbs
=============================================================================*/
div.note,
div.tip,
div.important,
div.caution,
div.warning,
p.blurb
{
font-size: 9pt; /* A little bit smaller than the main text */
line-height: 1.2;
display: block;
margin: 1pc 4% 0pc 4%;
padding: 0.5pc 0.5pc 0.5pc 0.5pc;
}
p.blurb img
{
padding: 1pt;
}
/*=============================================================================
Variable Lists
=============================================================================*/
div.variablelist
{
margin: 1em 0;
}
/* Make the terms in definition lists bold */
div.variablelist dl dt,
span.term
{
font-weight: bold;
font-size: 10pt;
}
div.variablelist table tbody tr td
{
text-align: left;
vertical-align: top;
padding: 0em 2em 0em 0em;
font-size: 10pt;
margin: 0em 0em 0.5em 0em;
line-height: 1;
}
div.variablelist dl dt
{
margin-bottom: 0.2em;
}
div.variablelist dl dd
{
margin: 0em 0em 0.5em 2em;
font-size: 10pt;
}
div.variablelist table tbody tr td p,
div.variablelist dl dd p
{
margin: 0em 0em 0.5em 0em;
line-height: 1;
}
/*=============================================================================
Misc
=============================================================================*/
/* Title of books and articles in bibliographies */
span.title
{
font-style: italic;
}
span.underline
{
text-decoration: underline;
}
span.strikethrough
{
text-decoration: line-through;
}
/* Copyright, Legal Notice */
div div.legalnotice p
{
text-align: left
}
/*=============================================================================
Colors
=============================================================================*/
@media screen
{
body {
background-color: #FFFFFF;
color: #000000;
}
/* Links */
a
{
color: #005a9c;
}
a:visited
{
color: #9c5a9c;
}
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
{
text-decoration: none; /* no underline */
color: #000000;
}
/* Syntax Highlighting */
.keyword { color: #0000AA; }
.identifier { color: #000000; }
.special { color: #707070; }
.preprocessor { color: #402080; }
.char { color: teal; }
.comment { color: #800000; }
.string { color: teal; }
.number { color: teal; }
.white_bkd { background-color: #FFFFFF; }
.dk_grey_bkd { background-color: #999999; }
/* Copyright, Legal Notice */
.copyright
{
color: #666666;
font-size: small;
}
div div.legalnotice p
{
color: #666666;
}
/* Program listing */
pre.synopsis
{
border: 1px solid #DCDCDC;
}
.programlisting,
.screen
{
border: 1px solid #DCDCDC;
}
td .programlisting,
td .screen
{
border: 0px solid #DCDCDC;
}
/* Blurbs */
div.note,
div.tip,
div.important,
div.caution,
div.warning,
p.blurb
{
border: 1px solid #DCDCDC;
}
/* Table of contents */
.toc
{
border: 1px solid #DCDCDC;
}
/* Tables */
div.informaltable table tr td,
div.table table tr td
{
border: 1px solid #DCDCDC;
}
div.informaltable table tr th,
div.table table tr th
{
background-color: #F0F0F0;
border: 1px solid #DCDCDC;
}
.copyright-footer
{
color: #8F8F8F;
}
/* Misc */
span.highlight
{
color: #00A000;
}
}
@media print
{
/* Links */
a
{
color: black;
}
a:visited
{
color: black;
}
.spirit-nav
{
display: none;
}
/* Program listing */
pre.synopsis
{
border: 1px solid gray;
}
.programlisting,
.screen
{
border: 1px solid gray;
}
td .programlisting,
td .screen
{
border: 0px solid #DCDCDC;
}
/* Table of contents */
.toc
{
border: 1px solid gray;
}
.informaltable table,
.table table
{
border: 1px solid gray;
border-collapse: collapse;
}
/* Tables */
div.informaltable table tr td,
div.table table tr td
{
border: 1px solid gray;
}
div.informaltable table tr th,
div.table table tr th
{
border: 1px solid gray;
}
table.simplelist tr td
{
border: none !important;
}
/* Misc */
span.highlight
{
font-weight: bold;
}
}
/*=============================================================================
Images
=============================================================================*/
span.inlinemediaobject img
{
vertical-align: middle;
}
/*==============================================================================
Super and Subscript: style so that line spacing isn't effected, see
http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341
==============================================================================*/
sup,
sub {
height: 0;
line-height: 1;
vertical-align: baseline;
_vertical-align: bottom;
position: relative;
}
sup {
bottom: 1ex;
}
sub {
top: .5ex;
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

View File

@ -1,52 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section Introduction]
The __boost_geometry__ (aka Generic Geometry Library, GGL), part of collection of
the Boost C++ Libraries, defines concepts, primitives and algorithms for solving
computational geometry problems.
The __boost_geometry__ contains a dimension-agnostic, coordinate-system-agnostic
and scalable kernel, based on concepts, meta-functions and tag- dispatching.
On top of that kernel, algorithms are built: area, length, perimeter, centroid,
convex hull, intersection (clipping), within (point in polygon), distance,
envelope (bounding box), simplify, transform, convert, and more.
The library is also designed to support high precision arithmetic numbers,
such as __gmp__.
The Boost Geometry contains instantiable geometry classes, but library users can
also use their own. Using registration macros or traits classes their geometries
can be adapted to fulfil the Boost Geometry concepts.
The Boost Geometry might be used in all domains where geometry plays a role:
mapping and GIS, game development, computer graphics and widgets, robotics,
astronomy and more. The core is designed to be as generic as possible and support
those domains. However, for now the development has been mostly GIS-oriented.
The Boost Geometry supports the extension model, the same way as __boost_gil__
also applies it. An extension is (mostly) something more specific to
like mentioned above.
The library follows existing conventions:
* conventions from boost
* conventions from the std library
* conventions and names from one of the __ogc__ standards on geometry
This Generic Geometry Library (Boost Geometry) is now being reviewed by
the Boost Community
The library can be downloaded from the Boost Sandbox, go to the download page
for more information.
The Boost Geometry bug tracker and Wiki are available at http://trac.osgeo.org/ggl/
[endsect]

View File

@ -1,15 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section Iterators (?)]
['TODO: long story about iterators...]
['TODO: end of long story about iterators...]
[endsect] [/ end of section Iterators]

View File

@ -1,63 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2009 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2009 Bruno Lalande, Paris, France.
Copyright (c) 2009 Mateusz Loskot (mateusz@loskot.net)
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)
===============================================================================/]
[section:quickstart Quick Start]
It is not possible to present all features of the whole library at a glance.
However, a few very small examples are shown below.
It should be possible to use a very small part of the library, for example
only the distance between two points.
int a[2] = {1,1};
int b[2] = {2,3};
double d = distance(a, b);
std::cout << "Distance a-b is:" << d << std::endl;
Other often used algorithms are point-in-polygon:
ring_2d poly;
double points[][2] = {{2.0, 1.3}, {4.1, 3.0}, {5.3, 2.6}, {2.9, 0.7}, {2.0, 1.3}};
append(poly, points);
boost::tuple<double, double> p = boost::make_tuple(3.7, 2.0);
std::cout << "Point p is in polygon? " << (within(p, poly) ? "YES" : "NO") << std::endl;
or area:
std::cout << "Area: " << area(poly) << std::endl;
It is possible, by the nature of a template library, to mix the point types declared above:
double d2 = distance(a, p);
std::cout << "Distance a-p is:" << d2 << std::endl;
The pieces above generate this output:
__img_quickstart_output__
It is also possible to use non-Cartesian points. For example: points on a sphere.
When then an algorithm such as distance is used the library "inspects" that it
is handling spherical points and calculates the distance over the sphere,
instead of applying the Pythagorean theorem.
Finally an example from a totally different domain: developing window-based applications,
for example using QtWidgets. We check if two rectangles overlap and if so, move the second
one to another place:
QRect r1(100, 200, 15, 15);
QRect r2(110, 210, 20, 20);
if (overlaps(r1, r2))
{
assign(r2, 200, 300, 220, 320);
}
More examples are on the page Examples
[endsect]

5
doc/quickbook/readme.txt Normal file
View File

@ -0,0 +1,5 @@
This folder quickbook was the first phase of the documentation.
Files left here should be merged with the current phase, one folder higher.
Barend, 31-12-2010

View File

@ -1,248 +0,0 @@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "Boost.Geometry Reference"
PROJECT_NUMBER = 0.1
OUTPUT_DIRECTORY = .
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = ./../../../
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = YES
INHERIT_DOCS = NO
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 2
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = NO
INLINE_INFO = NO
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= NO
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO
SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = ./doxygen.log
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = \
./../../../../boost/geometry/algorithms \
./../../../../boost/geometry/algorithms/overlay \
./../../../../boost/geometry/arithmetic \
./../../../../boost/geometry/core \
./../../../../boost/geometry/geometries \
./../../../../boost/geometry/geometries/adapted \
./../../../../boost/geometry/geometries/concepts \
./../../../../boost/geometry/iterators \
./../../../../boost/geometry/strategies \
./../../../../boost/geometry/strategies/agnostic \
./../../../../boost/geometry/strategies/cartesian \
./../../../../boost/geometry/strategies/concepts \
./../../../../boost/geometry/strategies/spherical \
./../../../../boost/geometry/strategies/transform \
./../../../../boost/geometry/util \
./../../../../boost/geometry/policies/relate/de9im.hpp \
./../../../../boost/geometry/policies/relate/direction.hpp \
./../../../../boost/geometry/policies/relate/tupled.hpp \
./../../../../boost/geometry/policies/relate/intersection_points_slope.hpp
FILE_PATTERNS = *.hpp
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = YES
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
USE_HTAGS = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 1
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = NO
HTML_OUTPUT = .
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = YES
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = YES
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = GENERATING_DOCUMENTATION \
BOOST_CONCEPT_REQUIRES(x)= \
BOOST_CONCEPT_ASSERT(x) = \
BOOST_STATIC_ASSERT(x) = \
DOXYGEN_SHOULD_SKIP_THIS=1 \
DOXYGEN_NO_DISPATCH=1 \
DOXYGEN_NO_IMPL=1 \
DOXYGEN_NO_DETAIL=1 \
DOXYGEN_NO_CONCEPT_MEMBERS=1 \
DOXYGEN_NO_TRAITS_SPECIALIZATIONS=1 \
DOXYGEN_NO_STRATEGY_SPECIALIZATIONS=1 \
DOXYGEN_NO_SPECIALIZATIONS=1
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE = reference.tags
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = NO
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,182 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[article Geometry
[quickbook 1.4]
[version 1.0]
[copyright 2009 Barend Gehrels, Bruno Lalande, Mateusz Loskot]
[authors [Gehrels, Barend], [Lalande, Bruno], [Loskot, Mateusz]]
[purpose Documentation of Boost.Geometry library]
[license
Distributed under 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])
]
]
[/ Links macros ///////////////////////////////////////////////////////////////]
[def __ggl__ [@http://trac.osgeo.org/ggl/ Generic Geometry Library]]
[def __ggl_short__ [@http://trac.osgeo.org/ggl/ GGL]]
[def __stl__ [@http://www.sgi.com/tech/stl/ STL]]
[def __boost__ [@http://www.boost.org/ Boost]]
[def __boost_gil__ [@boost:/libs/gil/index.html Boost.GIL]]
[def __gnu_gmp__ [@http://gmplib.org/ GMP]]
[def __ogc__ [@http://www.opengeospatial.org/ OGC]]
[/ Sections macros ////////////////////////////////////////////////////////////]
[/ TODO]
[/ Images macros //////////////////////////////////////////////////////////////]
[def __img_quickstart_output__ [$./images/quickstart_output.png]]
[/ Content starts here ////////////////////////////////////////////////////////]
This is the documentation of the newest version of __ggl__ (current Subversion trunk).
[/ TODO: This is proposal of G]
[section Introduction]
[endsect]
[section Tutorial]
[section Quick Start]
[endsect]
[section Examples]
[endsect]
[endsect] [/ end of section Examples]
[section Library Overview]
[section Design Rationale]
[endsect]
[section Strategy Rationale]
[endsect]
[section Spatial set-theoretic operations]
[endsect]
[section Robustness]
[endsect]
[endsect] [/ end of section Library Overview]
[section Reference]
[section Geometries]
[section Concepts]
[endsect] [/ end of section Concepts]
[section Provided Geometries] [/TOOD better name? --mloskot]
[endsect] [/ end of section Provided Geometries]
[section Adaption and Registration]
[endsect] [/ end of section Adaption and Registration]
[endsect] [/ end of section Geometries]
[section Coordinate Systems]
[endsect] [/ end of section Coordinate Systems]
[section Algorithms]
[section area]
[section Formal description] [/TOOD Theory as better name? --mloskot]
[endsect]
[section Parameters]
[endsect]
[section Complexity]
[endsect]
[section Example]
[endsect]
[section Notes]
[endsect]
[endsect] [/ end of section area]
[section distance]
[section Formal description] [/TOOD Theory as better name? --mloskot]
[endsect]
[section Parameters]
[endsect]
[section Complexity]
[endsect]
[section Example]
[endsect]
[section Notes]
[endsect]
[endsect] [/ end of section disance]
[endsect] [/ end of section Algorithms]
[section Strategies and Policies]
[endsect] [/ end of Strategies and Policies]
[section Iterators]
[endsect] [/ end of Iterators]
[section Utilities]
[endsect] [/ end of Utilities]
[endsect] [/ end of section Reference]
[section Extensions]
[section I/O]
[section DSV]
[endsect] [/ end of DSV]
[section SVG]
[endsect] [/ end of SVG]
[endsect] [/ end of I/O]
[section Spatial Index]
[section R-tree]
[endsect] [/ end of R-tree]
[endsect] [/ end of Spatial Index]
[section GIS]
[section I/O]
[endsect] [/ end of I/O]
[section Projections]
[endsect] [/ end of Projections]
[endsect] [/ end of GIS]
[endsect] [/ end of section Extensions]
[section Miscellaneous]
[section Release Notes] [/TODO: current status]
[endsect] [/ end of ]
[section Compilation] [/TOOD Was proposed as relations --mloskot]
[section Supported Compilers]
[endsect] [/ end of ]
[section Hints]
[endsect] [/ end of ]
[section Known Problems] [/TODO: Was proposed as issues --mloskot]
[endsect] [/ end of ]
[endsect] [/ end of Compilation]
[section Relations]
[section Boost C++ Libraries]
[endsect] [/ end of Boost]
[section C++ Standard Library]
[endsect] [/ end of C++Std]
[section OGC] [/TODO: matrix on Wiki]
[endsect] [/ end of OGC]
[endsect] [/ end of Affiliations]
[section Performance]
[endsect] [/ end of Performance]
[section Who uses Boost.Geometry]
[endsect] [/ end of Who Uses]
[section Future Work] [/TODO: Roadmap? --mloskot]
[endsect] [/ end of ]
[section Acknowledgments]
[endsect] [/ end of Acknowledgments]
[endsect] [/ end of Miscellaneous]

View File

@ -1,25 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section Tutorial]
['TODO: tutorial-like materials here...]
[include quickstart.qbk]
[section Examples]
[/TODO include example1.qbk]
[/TODO include example2.qbk]
[/TODO include ...]
[endsect]
['TODO: end of tutorial-like materials here...]
[endsect] [/ end of section Tutorial]

View File

@ -1,15 +0,0 @@
[/==============================================================================
Copyright (c) 1995-2010 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2008-2010 Bruno Lalande, Paris, France.
Copyright (c) 2009-2010 Mateusz Loskot (mateusz@loskot.net), London, UK
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)
===============================================================================/]
[section Utilities (?)]
['TODO: long story about utilities...]
['TODO: end of long story about utilities...]
[endsect] [/ end of section Coordinate Systems]

View File

@ -14,6 +14,13 @@ Procedure to create documentation using Doxygen, QuickBook and doxygen_xml2qbk
2) install QuickBook using http://www.boost.org/doc/libs/1_44_0/doc/html/quickbook/install.html#quickbook.install.linux
3) compile doxygen_xml2qbk, in .../boost/sandbox/geometry/other/programs/doxygen_xml2qbk
4) put binary somewhere, e.g. in /usr/local/bin/doxygen_xml2qbk
5) execute python file "make_qbk.py"
5) execute python file "make_qbk.py" (calling doxygen, doxygen_xml2qbk, bjam)
Folders in this folder:
doxy: folders and files needed for doxygen input and output
other: older documentation (subject to update or deletion)
snippets: code snippets (might be renamed to examples and contain fully runnable examples)
reference: contains generated QBK files (by doxygen_xml2qbk)
html: contains generated HTML files
-

View File

@ -1,9 +1,7 @@
[section:reference Reference]
[section:algorithms Algorithms]
[section:area area]
[include reference/area.qbk]
[endsect]
@ -16,13 +14,13 @@
[include reference/centroid.qbk]
[endsect]
[/section:combine combine]
[/include reference/combine.qbk]
[/endsect]
[section:combine combine]
[include reference/combine.qbk]
[endsect]
[/section:convert convert]
[/include reference/convert.qbk]
[/endsect]
[section:convert convert]
[include reference/convert.qbk]
[endsect]
[section:convex_hull convex_hull]
[include reference/convex_hull.qbk]
@ -32,9 +30,9 @@
[include reference/difference.qbk]
[endsect]
[/section:disjoint disjoint]
[/include reference/disjoint.qbk]
[/endsect]
[section:disjoint disjoint]
[include reference/disjoint.qbk]
[endsect]
[section:dissolve dissolve]
[include reference/dissolve.qbk]
@ -49,13 +47,13 @@
[include reference/envelope.qbk]
[endsect]
[/section:equals equals]
[/include reference/equals.qbk]
[/endsect]
[section:equals equals]
[include reference/equals.qbk]
[endsect]
[/ section:for_each for_each]
[/ include reference/for_each.qbk]
[/ endsect]
[/section:for_each for_each]
[/include reference/for_each.qbk]
[/endsect]
[section:intersection intersection]
[include reference/intersection.qbk]
@ -105,7 +103,7 @@
[endsect]
[endsect]
[endsect] [/algorithms]
@ -135,7 +133,6 @@
[include reference/closing_iterator.qbk]
[endsect]
[endsect]
[endsect]
[endsect] [/reference]

View File

@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__combine.xml]
[section:combine_2 combine (2)]
[/ Generated from doxy/doxygen_output/xml/group__combine.xml]
[section:combine combine]
Combines a box with another geometry (box, point).
@ -13,17 +13,11 @@ void combine (Box &box, Geometry const &geometry)``
[table
[[Type] [Concept] [Name] [Description] ]
[[Box &] [type of the box ] [box] [box to combine another geometry with, might be changed ]]
[[Geometry const &] [Any type fulfilling a Geometry concept ] [geometry] [A model of the specified concept ]]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/combine.hpp>`

View File

@ -1,2 +1,38 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1concept_1_1_point.xml.xml]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1concept_1_1_point.xml]
[section:concept::Point concept::Point]
[heading Description]
A legacy point, defining the necessary specializations to fulfil to the concept.
Suppose that the following point is defined:
It can then be adapted to the concept as following:
Note that it is done like above to show the system. Users will normally use the registration macro.
A read-only legacy point, using a macro to fulfil to the
The point looks like the following:
It uses the macro as following:
[heading Synopsis]
``template<typename Geometry>
class concept::Point
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Geometry] []]
]
[heading Header]
`#include <boost/geometry/geometries/concepts/point_concept.hpp>`
[endsect]

View File

@ -1,9 +1,12 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__convert.xml]
[section:convert_2 convert (2)]
[/ Generated from doxy/doxygen_output/xml/group__convert.xml]
[section:convert convert]
Converts one geometry to another geometry.
[heading Description]
The convert algorithm converts one geometry, e.g. a BOX, to another geometry, e.g. a RING. This only if it is possible and applicable.
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
void convert (Geometry1 const &geometry1, Geometry2 &geometry2)``
@ -12,18 +15,12 @@ void convert (Geometry1 const &geometry1, Geometry2 &geometry2)``
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1 const &] [Any type fulfilling a Geometry concept ] [geometry1] [A model of the specified concept (source) ]]
[[Geometry2 &] [Any type fulfilling a Geometry concept ] [geometry2] [A model of the specified concept (target) ]]
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept (source) ]]
[[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept (target) ]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/convert.hpp>`

View File

@ -1,30 +1,27 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__difference.xml]
[section:difference_3 difference (3)]
[/ Generated from doxy/doxygen_output/xml/group__difference.xml]
[section:difference difference]
[heading Description]
Calculate the difference of two geometries
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Collection>
void difference (Geometry1 const &geometry1, Geometry2 geometry2, Collection &output_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] [Any type fulfilling a Geometry concept ] [geometry2] [A model of the specified concept ]]
[[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>`

View File

@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__disjoint.xml]
[section:disjoint_2 disjoint (2)]
[/ Generated from doxy/doxygen_output/xml/group__disjoint.xml]
[section:disjoint disjoint]
Checks if two geometries are disjoint.
@ -12,8 +12,8 @@ bool disjoint (Geometry1 const &geometry1, Geometry2 const &geometry2)``
[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 ]]
[[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 ]]
]
@ -21,12 +21,6 @@ bool disjoint (Geometry1 const &geometry1, Geometry2 const &geometry2)``
Returns true if two geometries are disjoint
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/disjoint.hpp>`

View File

@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__equals.xml]
[section:equals_2 equals (2)]
[/ Generated from doxy/doxygen_output/xml/group__equals.xml]
[section:equals equals]
Checks if a geometry are spatially equal.
@ -12,8 +12,8 @@ bool equals (Geometry1 const &geometry1, Geometry2 const &geometry2)``
[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 ]]
[[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 ]]
]
@ -21,12 +21,6 @@ bool equals (Geometry1 const &geometry1, Geometry2 const &geometry2)``
Returns true if two geometries are spatially disjoint
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/equals.hpp>`

View File

@ -1,38 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__for__each.xml]
[section:for_each_point_2 for_each_point (2)]
Calls functor for geometry.
[heading Description]
Calls the functor the specified
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_point (Geometry const &geometry, Functor f)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [] [geometry] [geometry to loop through ]]
[[Functor] [] [f] [functor to use]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/for_each.hpp>`
[endsect]
[section:for_each_point_2 for_each_point (2)]
[/ Generated from doxy/doxygen_output/xml/group__for__each.xml]
[section:for_each_point_2 for_each_point]
Calls functor for geometry.
@ -53,27 +21,21 @@ Functor for_each_point (Geometry &geometry, Functor f)``
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/for_each.hpp>`
[endsect]
[section:for_each_segment_2 for_each_segment (2)]
[section:for_each_point_2 for_each_point]
Calls functor for segments on linestrings, rings, polygons, ...
Calls functor for geometry.
[heading Description]
Calls the functor all
Calls the functor the specified
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_segment (Geometry const &geometry, Functor f)``
Functor for_each_point (Geometry const &geometry, Functor f)``
[heading Parameters]
@ -85,18 +47,12 @@ Functor for_each_segment (Geometry const &geometry, Functor f)``
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/for_each.hpp>`
[endsect]
[section:for_each_segment_2 for_each_segment (2)]
[section:for_each_segment_2 for_each_segment]
Calls functor for segments on linestrings, rings, polygons, ...
@ -117,12 +73,32 @@ Functor for_each_segment (Geometry &geometry, Functor f)``
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/for_each.hpp>`
[endsect]
[section:for_each_segment_2 for_each_segment]
Calls functor for segments on linestrings, rings, polygons, ...
[heading Description]
Calls the functor all
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_segment (Geometry const &geometry, Functor f)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [] [geometry] [geometry to loop through ]]
[[Functor] [] [f] [functor to use]]
]
[heading Header]
`#include <boost/geometry/algorithms/for_each.hpp>`

View File

@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__overlaps.xml]
[section:overlaps_2 overlaps (2)]
[/ Generated from doxy/doxygen_output/xml/group__overlaps.xml]
[section:overlaps overlaps]
Checks if two geometries overlap.
@ -21,12 +21,6 @@ bool overlaps (Geometry1 const &geometry1, Geometry2 const &geometry2)``
Returns true if two geometries overlap
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/overlaps.hpp>`

View File

@ -1,30 +1,24 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__sym__difference.xml]
[section:sym_difference_3 sym_difference (3)]
[/ Generated from doxy/doxygen_output/xml/group__sym__difference.xml]
[section:sym_difference sym_difference]
calculates2{symmetric difference}
Calculate the symmetric difference of two geometries.
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Collection>
void sym_difference (Geometry1 geometry1, Geometry2 geometry2, Collection &output_collection)``
void sym_difference (Geometry1 const &geometry1, Geometry2 const &geometry2, Collection &output_collection)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1] [Any type fulfilling a Geometry concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2] [Any type fulfilling a Geometry concept ] [geometry2] [A model of the specified concept ]]
[[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>`

View File

@ -1,36 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__transform.xml]
[section:transform_3 transform (3)]
Transforms from one geometry to another geometry using a strategy.
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Strategy>
bool transform (Geometry1 const &geometry1, Geometry2 &geometry2, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1 const &] [Any type fulfilling a Geometry concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 &] [Any type fulfilling a Geometry concept ] [geometry2] [A model of the specified concept ]]
[[Strategy const &] [strategy ] [strategy] [the strategy to be used for transformation ]]
]
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/transform.hpp>`
[endsect]
[section:transform_2 transform (2)]
[/ Generated from doxy/doxygen_output/xml/group__transform.xml]
[section:transform_2 transform]
Transforms from one geometry to another geometry using a strategy.
@ -42,8 +12,8 @@ bool transform (Geometry1 const &geometry1, Geometry2 &geometry2)``
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1 const &] [Any type fulfilling a Geometry concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 &] [Any type fulfilling a Geometry concept ] [geometry2] [A model of the specified concept ]]
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
]
@ -51,12 +21,30 @@ bool transform (Geometry1 const &geometry1, Geometry2 &geometry2)``
true if the transformation could be done
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/transform.hpp>`
[endsect]
[section:transform_3 transform]
Transforms from one geometry to another geometry using a strategy.
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Strategy>
bool transform (Geometry1 const &geometry1, Geometry2 &geometry2, Strategy const &strategy)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
[[Strategy const &] [strategy ] [strategy] [the strategy to be used for transformation ]]
]
[heading Header]
`#include <boost/geometry/algorithms/transform.hpp>`

View File

@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
[/ Generated from ..\doxygen_output\xml\group__union.xml]
[section:union__3 union_ (3)]
[/ Generated from doxy/doxygen_output/xml/group__union.xml]
[section:union_ union_]
Combines two geometries which each other.
@ -12,59 +12,19 @@ void union_ (Geometry1 const &geometry1, Geometry2 const &geometry2, Collection
[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 ]]
[[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/union.hpp>`
[endsect]
[section:union_inserter_4 union_inserter (4)]
Combines two geometries which each other.
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
OutputIterator union_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out, Strategy const &strategy)``
[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 ]]
[[OutputIterator] [output iterator ] [out] [the output iterator, outputting polygons ]]
[[Strategy const &] [compound strategy for intersection ] [strategy] [the strategy ]]
]
[heading Returns]
the output iterator
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/union.hpp>`
[endsect]
[section:union_inserter_3 union_inserter (3)]
[section:union_inserter_3 union_inserter]
Combines two geometries which each other.
@ -76,8 +36,9 @@ OutputIterator union_inserter (Geometry1 const &geometry1, Geometry2 const &geom
[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 ]]
[[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 ]]
]
@ -86,12 +47,35 @@ OutputIterator union_inserter (Geometry1 const &geometry1, Geometry2 const &geom
the output iterator
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/union.hpp>`
[endsect]
[section:union_inserter_4 union_inserter]
Combines two geometries which each other.
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
OutputIterator union_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, outputting polygons ]]
[[Strategy const &] [compound strategy for intersection ] [strategy] [the strategy ]]
]
[heading Returns]
the output iterator
[heading Header]
`#include <boost/geometry/algorithms/union.hpp>`

16
index.html Normal file
View File

@ -0,0 +1,16 @@
<!--
Copyright 2010 Barend Gehrels.
Distributed under 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)
-->
<html>
<head>
<meta http-equiv="refresh" content="0; URL=doc/html/index.html">
</head>
<body>
Automatic redirection failed, please go to
<a href="doc/html/index.html">doc/html/index.html</a>
</body>
</html>