|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r68681 - in trunk/libs/geometry/doc: . doxy reference
From: barend.gehrels_at_[hidden]
Date: 2011-02-06 16:06:55
Author: barendgehrels
Date: 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
New Revision: 68681
URL: http://svn.boost.org/trac/boost/changeset/68681
Log:
Docupdate, including get/set
Text files modified:
trunk/libs/geometry/doc/doxy/Doxyfile | 27 +++++++++++--------
trunk/libs/geometry/doc/geometry.qbk | 4 ++
trunk/libs/geometry/doc/quickref.xml | 2 -
trunk/libs/geometry/doc/reference.qbk | 6 +++
trunk/libs/geometry/doc/reference/append.qbk | 2
trunk/libs/geometry/doc/reference/area.qbk | 4 +-
trunk/libs/geometry/doc/reference/area_huiller.qbk | 6 ++--
trunk/libs/geometry/doc/reference/area_surveyor.qbk | 4 +-
trunk/libs/geometry/doc/reference/arithmetic.qbk | 20 +++++++-------
trunk/libs/geometry/doc/reference/assign.qbk | 20 +++++++-------
trunk/libs/geometry/doc/reference/box.qbk | 12 ++++----
trunk/libs/geometry/doc/reference/box_iterator.qbk | 4 +-
trunk/libs/geometry/doc/reference/box_range.qbk | 6 ++--
trunk/libs/geometry/doc/reference/buffer.qbk | 4 +-
trunk/libs/geometry/doc/reference/centroid.qbk | 8 ++--
trunk/libs/geometry/doc/reference/centroid_average.qbk | 4 +-
trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk | 4 +-
trunk/libs/geometry/doc/reference/centroid_exception.qbk | 4 +-
trunk/libs/geometry/doc/reference/circular_iterator.qbk | 6 ++--
trunk/libs/geometry/doc/reference/clear.qbk | 2
trunk/libs/geometry/doc/reference/closing_iterator.qbk | 8 ++--
trunk/libs/geometry/doc/reference/combine.qbk | 2
trunk/libs/geometry/doc/reference/convert.qbk | 2
trunk/libs/geometry/doc/reference/convex_hull.qbk | 4 +-
trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk | 4 +-
trunk/libs/geometry/doc/reference/correct.qbk | 2
trunk/libs/geometry/doc/reference/difference.qbk | 2
trunk/libs/geometry/doc/reference/disjoint.qbk | 2
trunk/libs/geometry/doc/reference/distance.qbk | 6 ++--
trunk/libs/geometry/doc/reference/distance_cross_track.qbk | 10 +++---
trunk/libs/geometry/doc/reference/distance_haversine.qbk | 6 ++--
trunk/libs/geometry/doc/reference/distance_projected_point.qbk | 2
trunk/libs/geometry/doc/reference/distance_pythagoras.qbk | 2
trunk/libs/geometry/doc/reference/envelope.qbk | 4 +-
trunk/libs/geometry/doc/reference/equals.qbk | 2
trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk | 6 ++--
trunk/libs/geometry/doc/reference/exterior_ring.qbk | 4 +-
trunk/libs/geometry/doc/reference/for_each.qbk | 8 ++--
trunk/libs/geometry/doc/reference/get.qbk | 55 ++++++++++++++++++++++++++++++++++-----
trunk/libs/geometry/doc/reference/identity_view.qbk | 10 +++---
trunk/libs/geometry/doc/reference/interior_rings.qbk | 4 +-
trunk/libs/geometry/doc/reference/intersection.qbk | 6 ++--
trunk/libs/geometry/doc/reference/intersects.qbk | 4 +-
trunk/libs/geometry/doc/reference/length.qbk | 4 +-
trunk/libs/geometry/doc/reference/linestring.qbk | 4 +-
trunk/libs/geometry/doc/reference/make.qbk | 8 ++--
trunk/libs/geometry/doc/reference/multi_point.qbk | 4 +-
trunk/libs/geometry/doc/reference/num_geometries.qbk | 2
trunk/libs/geometry/doc/reference/num_interior_rings.qbk | 2
trunk/libs/geometry/doc/reference/num_points.qbk | 2
trunk/libs/geometry/doc/reference/overlaps.qbk | 2
trunk/libs/geometry/doc/reference/perimeter.qbk | 4 +-
trunk/libs/geometry/doc/reference/point.qbk | 8 ++--
trunk/libs/geometry/doc/reference/point_xy.qbk | 12 ++++----
trunk/libs/geometry/doc/reference/polygon.qbk | 10 +++---
trunk/libs/geometry/doc/reference/referring_segment.qbk | 2
trunk/libs/geometry/doc/reference/reverse.qbk | 2
trunk/libs/geometry/doc/reference/ring.qbk | 4 +-
trunk/libs/geometry/doc/reference/segment.qbk | 4 +-
trunk/libs/geometry/doc/reference/segment_range.qbk | 6 ++--
trunk/libs/geometry/doc/reference/segment_range_iterator.qbk | 8 ++--
trunk/libs/geometry/doc/reference/set.qbk | 55 ++++++++++++++++++++++++++++++++++-----
trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk | 2
trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk | 2
trunk/libs/geometry/doc/reference/simplify.qbk | 8 ++--
trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk | 2
trunk/libs/geometry/doc/reference/sym_difference.qbk | 2
trunk/libs/geometry/doc/reference/transform.qbk | 4 +-
trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk | 2
trunk/libs/geometry/doc/reference/transform_map_transformer.qbk | 4 +-
trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk | 2
trunk/libs/geometry/doc/reference/union.qbk | 6 ++--
trunk/libs/geometry/doc/reference/unique.qbk | 2
trunk/libs/geometry/doc/reference/within.qbk | 4 +-
trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk | 4 +-
trunk/libs/geometry/doc/reference/within_franklin.qbk | 4 +-
trunk/libs/geometry/doc/reference/within_winding.qbk | 4 +-
77 files changed, 296 insertions(+), 203 deletions(-)
Modified: trunk/libs/geometry/doc/doxy/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/doxy/Doxyfile (original)
+++ trunk/libs/geometry/doc/doxy/Doxyfile 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,6 +39,7 @@
# \return* for various return cases
ALIASES = qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
qbk{2}="\xmlonly <qbk.\1>\2</qbk.\1> \endxmlonly" \
+ qbk_skip="\xmlonly <qbk.skip/> \endxmlonly" \
brief_calc{1}="Calculates the \1 of a geometry" \
brief_calc2{1}="Calculate the \1 of two geometries" \
brief_calc2{2}="Calculate the \1 \2 two geometries" \
@@ -49,26 +50,29 @@
brief_macro{1}="Macro to register a \1" \
brief_macro_const=" (const version)" \
brief_macro_getset=" (having separate get/set methods)" \
+ tparam_allocator="container-allocator-type" \
+ tparam_box="Any type fulfilling a Box Concept" \
+ tparam_box_or_segment="Any type fulfilling a Box Concept or a Segment Concept" \
+ tparam_calculation="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" \
+ tparam_container="container type, for example std::vector, std::deque" \
+ tparam_dimension_required="Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry" \
+ tparam_first_point="first point type" \
tparam_geometry="Any type fulfilling a Geometry Concept" \
tparam_geometry{1}="A type fulfilling a \1 Concept" \
- tparam_point="Any type fulfilling a Point Concept" \
- tparam_box="Any type fulfilling a Box Concept" \
- tparam_strategy{1}="Any type fulfilling a \1 Strategy Concept" \
+ tparam_index_required="Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point." \
tparam_numeric="numerical type (int, double, ttmath, ...)" \
- tparam_calculation="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" \
+ tparam_out{1}="A valid output iterator type, accepting geometries of \1 Concept" \
+ tparam_point="Any type fulfilling a Point Concept" \
tparam_point="point type" \
- tparam_first_point="first point type" \
tparam_second_point="second point type" \
tparam_segment_point="segment point type" \
- tparam_container="container type, for example std::vector, std::deque" \
- tparam_allocator="container-allocator-type" \
- tparam_out{1}="A valid output iterator type, accepting geometries of \1 Concept" \
- param_geometry="A model of the specified concept" \
+ tparam_strategy{1}="Any type fulfilling a \1 Strategy Concept" \
param_box="A model of the specified Box Concept" \
+ param_geometry="A model of the specified concept" \
+ param_out{1}="The output iterator, to which \1 geometries are feeded" \
param_point="A model of the specified Point Concept" \
- param_strategy{1}="The strategy which will be used for \1 calculations" \
param_set{1}="which is set to the \1" \
- param_out{1}="The output iterator, to which \1 geometries are feeded" \
+ param_strategy{1}="The strategy which will be used for \1 calculations" \
param_macro_type{1}="\1 type to be registered" \
param_macro_coortype{1}="Type of the coordinates of the \1 (e.g. double)" \
param_macro_coorsystem="Coordinate system (e.g. cs::cartesian)" \
@@ -88,6 +92,7 @@
details_strategy_reasons="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." \
details_make{1}="This version with the make_ prefix returns the \1, and a template parameter must therefore be specified in the call." \
details_inserter{1}="This version with the _inserter suffix outputs the \1 to an output iterator, and a template parameter must therefore be specified in the call." \
+ details_get_set="The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere." \
return_calc{1}="The calculated \1" \
return_check{1}="Returns true if the geometry \1" \
return_check2{1}="Returns true if two geometries \1" \
Modified: trunk/libs/geometry/doc/geometry.qbk
==============================================================================
--- trunk/libs/geometry/doc/geometry.qbk (original)
+++ trunk/libs/geometry/doc/geometry.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -78,6 +78,10 @@
[import src/examples/algorithms/intersects_linestring.cpp]
[import src/examples/algorithms/simplify.cpp]
[import src/examples/algorithms/simplify_inserter.cpp]
+[import src/examples/core/get_point.cpp]
+[import src/examples/core/get_box.cpp]
+[import src/examples/core/set_point.cpp]
+[import src/examples/core/set_box.cpp]
[import src/examples/geometries/point.cpp]
[import src/examples/geometries/register/point.cpp]
Modified: trunk/libs/geometry/doc/quickref.xml
==============================================================================
--- trunk/libs/geometry/doc/quickref.xml (original)
+++ trunk/libs/geometry/doc/quickref.xml 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -159,12 +159,10 @@
<simplelist type="vert" columns="1">
<member><link linkend="geometry.reference.access.exterior_ring">exterior_ring</link></member>
<member><link linkend="geometry.reference.access.get">get</link></member>
- <member><link linkend="geometry.reference.access.get_as_radian">get_as_radian</link></member>
<member><link linkend="geometry.reference.access.interior_rings">interior_rings</link></member>
<member><link linkend="geometry.reference.access.num_interior_rings">num_interior_rings</link></member>
<member><link linkend="geometry.reference.access.num_points">num_points</link></member>
<member><link linkend="geometry.reference.access.set">set</link></member>
- <member><link linkend="geometry.reference.access.set_from_radian">set_from_radian</link></member>
</simplelist>
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
Modified: trunk/libs/geometry/doc/reference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference.qbk (original)
+++ trunk/libs/geometry/doc/reference.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -168,7 +168,9 @@
[include reference/exterior_ring.qbk]
[endsect]
+[section:get get]
[include reference/get.qbk]
+[endsect]
[section:interior_rings interior_rings]
[include reference/interior_rings.qbk]
@@ -176,8 +178,10 @@
[include reference/num_points.qbk]
[include reference/num_interior_rings.qbk]
-[include reference/set.qbk]
+[section:set set]
+[include reference/set.qbk]
+[endsect]
[endsect] [/access functions]
Modified: trunk/libs/geometry/doc/reference/append.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/append.qbk (original)
+++ trunk/libs/geometry/doc/reference/append.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry, typename RoP>
-void append (Geometry &geometry, RoP const &range_or_point, int ring_index=-1, int multi_index=0)``
+void append(Geometry & geometry, RoP const & range_or_point, int ring_index, int multi_index)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/area.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area.qbk (original)
+++ trunk/libs/geometry/doc/reference/area.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry, typename Strategy>
-Strategy::return_type area (Geometry const &geometry, Strategy const &strategy)``
+Strategy::return_type area(Geometry const & geometry, Strategy const & strategy)``
[heading Parameters]
@@ -71,7 +71,7 @@
[heading Synopsis]
``template<typename Geometry>
-area_result<Geometry>::type area (Geometry const &geometry)``
+area_result<Geometry>::type area(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/area_huiller.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area_huiller.qbk (original)
+++ trunk/libs/geometry/doc/reference/area_huiller.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -35,7 +35,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``huiller (double radius=1.0)``
+[[``huiller(double radius = 1.0)``
] [] [[* double]: ['radius]:
@@ -48,7 +48,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, excess_sum &state) const ``
+[[``void apply(PointOfSegment const & p1, PointOfSegment const & p2, & state)``
] [] [[* PointOfSegment const &]: ['p1]:
@@ -60,7 +60,7 @@
]]
-[[``return_type result (excess_sum const &state) const ``
+[[``return_type result( const & state)``
] [] [[* const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/area_surveyor.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area_surveyor.qbk (original)
+++ trunk/libs/geometry/doc/reference/area_surveyor.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -38,7 +38,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, summation &state)``
+[[``void apply(PointOfSegment const & p1, PointOfSegment const & p2, summation & state)``
] [] [[* PointOfSegment const &]: ['p1]:
@@ -50,7 +50,7 @@
]]
-[[``return_type result (summation const &state)``
+[[``return_type result(summation const & state)``
] [] [[* summation const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/arithmetic.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/arithmetic.qbk (original)
+++ trunk/libs/geometry/doc/reference/arithmetic.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Point1, typename Point2>
-void add_point (Point1 &p1, Point2 const &p2)``
+void add_point(Point1 & p1, Point2 const & p2)``
[heading Parameters]
@@ -51,7 +51,7 @@
[heading Synopsis]
``template<typename Point>
-void add_value (Point &p, typename detail::param< Point >::type value)``
+void add_value(Point & p, typename detail::param< Point >::type value)``
[heading Parameters]
@@ -83,7 +83,7 @@
[heading Synopsis]
``template<typename P1, typename P2>
-P1 cross_product (P1 const &p1, P2 const &p2)``
+P1 cross_product(P1 const & p1, P2 const & p2)``
[heading Parameters]
@@ -112,7 +112,7 @@
[heading Synopsis]
``template<typename Point1, typename Point2>
-void divide_point (Point1 &p1, Point2 const &p2)``
+void divide_point(Point1 & p1, Point2 const & p2)``
[heading Parameters]
@@ -141,7 +141,7 @@
[heading Synopsis]
``template<typename Point>
-void divide_value (Point &p, typename detail::param< Point >::type value)``
+void divide_value(Point & p, typename detail::param< Point >::type value)``
[heading Parameters]
@@ -170,7 +170,7 @@
[heading Synopsis]
``template<typename P1, typename P2>
-select_coordinate_type<P1, P2>::type dot_product (P1 const &p1, P2 const &p2)``
+select_coordinate_type<P1, P2>::type dot_product(P1 const & p1, P2 const & p2)``
[heading Parameters]
@@ -205,7 +205,7 @@
[heading Synopsis]
``template<typename Point1, typename Point2>
-void multiply_point (Point1 &p1, Point2 const &p2)``
+void multiply_point(Point1 & p1, Point2 const & p2)``
[heading Parameters]
@@ -234,7 +234,7 @@
[heading Synopsis]
``template<typename Point>
-void multiply_value (Point &p, typename detail::param< Point >::type value)``
+void multiply_value(Point & p, typename detail::param< Point >::type value)``
[heading Parameters]
@@ -266,7 +266,7 @@
[heading Synopsis]
``template<typename Point1, typename Point2>
-void subtract_point (Point1 &p1, Point2 const &p2)``
+void subtract_point(Point1 & p1, Point2 const & p2)``
[heading Parameters]
@@ -295,7 +295,7 @@
[heading Synopsis]
``template<typename Point>
-void subtract_value (Point &p, typename detail::param< Point >::type value)``
+void subtract_value(Point & p, typename detail::param< Point >::type value)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/assign.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/assign.qbk (original)
+++ trunk/libs/geometry/doc/reference/assign.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry, typename Range>
-void assign (Geometry &geometry, Range const &range)``
+void assign(Geometry & geometry, Range const & range)``
[heading Parameters]
@@ -48,7 +48,7 @@
[heading Synopsis]
``template<typename Geometry, typename Type>
-void assign (Geometry &geometry, Type const &c1, Type const &c2, Type const &c3, Type const &c4)``
+void assign(Geometry & geometry, Type const & c1, Type const & c2, Type const & c3, Type const & c4)``
[heading Parameters]
@@ -80,7 +80,7 @@
[heading Synopsis]
``template<typename Geometry, typename Type>
-void assign (Geometry &geometry, Type const &c1, Type const &c2, Type const &c3)``
+void assign(Geometry & geometry, Type const & c1, Type const & c2, Type const & c3)``
[heading Parameters]
@@ -111,7 +111,7 @@
[heading Synopsis]
``template<typename Geometry, typename Type>
-void assign (Geometry &geometry, Type const &c1, Type const &c2)``
+void assign(Geometry & geometry, Type const & c1, Type const & c2)``
[heading Parameters]
@@ -141,7 +141,7 @@
[heading Synopsis]
``template<typename Box, typename Point>
-void assign_box_corners (Box const &box, Point &lower_left, Point &lower_right, Point &upper_left, Point &upper_right)``
+void assign_box_corners(Box const & box, Point & lower_left, Point & lower_right, Point & upper_left, Point & upper_right)``
[heading Parameters]
@@ -176,7 +176,7 @@
[heading Synopsis]
``template<typename Geometry>
-void assign_inverse (Geometry &geometry)``
+void assign_inverse(Geometry & geometry)``
[heading Parameters]
@@ -204,7 +204,7 @@
[heading Synopsis]
``template<std::size_t Index, typename Point, typename Geometry>
-void assign_point_from_index (Geometry const &geometry, Point &point)``
+void assign_point_from_index(Geometry const & geometry, Point & point)``
[heading Parameters]
@@ -234,7 +234,7 @@
[heading Synopsis]
``template<std::size_t Index, typename Geometry, typename Point>
-void assign_point_to_index (Point const &point, Geometry &geometry)``
+void assign_point_to_index(Point const & point, Geometry & geometry)``
[heading Parameters]
@@ -267,7 +267,7 @@
[heading Synopsis]
``template<typename Geometry>
-void assign_zero (Geometry &geometry)``
+void assign_zero(Geometry & geometry)``
[heading Parameters]
@@ -298,7 +298,7 @@
[heading Synopsis]
``template<typename Src, typename Dst>
-void copy_coordinates (Src const &source, Dst &dest)``
+void copy_coordinates(Src const & source, Dst & dest)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/box.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box.qbk (original)
+++ trunk/libs/geometry/doc/reference/box.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -37,13 +37,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``box ()``
+[[``box``
] [] [
]]
-[[``box (Point const &min_corner, Point const &max_corner)``
+[[``box(Point const & min_corner, Point const & max_corner)``
] [Constructor taking the minimum corner point and the maximum corner point. ] [[* Point const &]: ['min_corner]:
@@ -58,25 +58,25 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``Point const & min_corner () const ``
+[[``Point const & min_corner``
] [] [
]]
-[[``Point const & max_corner () const ``
+[[``Point const & max_corner``
] [] [
]]
-[[``Point & min_corner ()``
+[[``Point & min_corner``
] [] [
]]
-[[``Point & max_corner ()``
+[[``Point & max_corner``
] [] [
Modified: trunk/libs/geometry/doc/reference/box_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/box_iterator.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``box_iterator (Box const &box)``
+[[``box_iterator(Box const & box)``
] [] [[* Box const &]: ['box]:
@@ -42,7 +42,7 @@
]]
-[[``box_iterator (Box const &box, bool)``
+[[``box_iterator(Box const & box, bool )``
] [] [[* Box const &]: ['box]:
Modified: trunk/libs/geometry/doc/reference/box_range.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box_range.qbk (original)
+++ trunk/libs/geometry/doc/reference/box_range.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``box_range (Box const &box)``
+[[``box_range(Box const & box)``
] [] [[* Box const &]: ['box]:
@@ -47,13 +47,13 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``const_iterator begin () const ``
+[[``const_iterator begin``
] [] [
]]
-[[``const_iterator end () const ``
+[[``const_iterator end``
] [] [
Modified: trunk/libs/geometry/doc/reference/buffer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/buffer.qbk (original)
+++ trunk/libs/geometry/doc/reference/buffer.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Input, typename Output, typename Distance>
-void buffer (Input const &geometry_in, Output &geometry_out, Distance const &distance, Distance const &chord_length=-1)``
+void buffer(Input const & geometry_in, Output & geometry_out, Distance const & distance, Distance const & chord_length)``
[heading Parameters]
@@ -58,7 +58,7 @@
[heading Synopsis]
``template<typename Output, typename Input, typename T, >
-Output make_buffer (Input const &geometry, T const &distance, T const &chord_length=-1)``
+Output make_buffer(Input const & geometry, T const & distance, T const & chord_length)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/centroid.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry, typename Point>
-void centroid (Geometry const &geometry, Point &c)``
+void centroid(Geometry const & geometry, Point & c)``
[heading Parameters]
@@ -56,7 +56,7 @@
[heading Synopsis]
``template<typename Geometry, typename Point, typename Strategy>
-void centroid (Geometry const &geometry, Point &c, Strategy const &strategy)``
+void centroid(Geometry const & geometry, Point & c, Strategy const & strategy)``
[heading Parameters]
@@ -93,7 +93,7 @@
[heading Synopsis]
``template<typename Point, typename Geometry, typename Strategy>
-Point make_centroid (Geometry const &geometry, Strategy const &strategy)``
+Point make_centroid(Geometry const & geometry, Strategy const & strategy)``
[heading Parameters]
@@ -133,7 +133,7 @@
[heading Synopsis]
``template<typename Point, typename Geometry>
-Point make_centroid (Geometry const &geometry)``
+Point make_centroid(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/centroid_average.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid_average.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid_average.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -35,7 +35,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void apply (Point const &p, sum &state)``
+[[``void apply(Point const & p, sum & state)``
] [] [[* Point const &]: ['p]:
@@ -45,7 +45,7 @@
]]
-[[``void result (sum const &state, PointCentroid ¢roid)``
+[[``void result(sum const & state, PointCentroid & centroid)``
] [] [[* sum const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -45,7 +45,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, sums &state)``
+[[``void apply(PointOfSegment const & p1, PointOfSegment const & p2, sums & state)``
] [] [[* PointOfSegment const &]: ['p1]:
@@ -57,7 +57,7 @@
]]
-[[``bool result (sums const &state, Point ¢roid)``
+[[``bool result(sums const & state, Point & centroid)``
] [] [[* sums const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/centroid_exception.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid_exception.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid_exception.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -31,7 +31,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``centroid_exception ()``
+[[``centroid_exception``
] [] [
@@ -42,7 +42,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``char const * what () const ``
+[[``char const * what``
] [] [
Modified: trunk/libs/geometry/doc/reference/circular_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/circular_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/circular_iterator.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``circular_iterator (Iterator begin, Iterator end, Iterator start)``
+[[``circular_iterator(Iterator begin, Iterator end, Iterator start)``
] [] [[* Iterator]: ['begin]:
@@ -46,7 +46,7 @@
]]
-[[``circular_iterator (Iterator end)``
+[[``circular_iterator(Iterator end)``
] [] [[* Iterator]: ['end]:
@@ -59,7 +59,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void moveto (Iterator it)``
+[[``void moveto(Iterator it)``
] [] [[* Iterator]: ['it]:
Modified: trunk/libs/geometry/doc/reference/clear.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/clear.qbk (original)
+++ trunk/libs/geometry/doc/reference/clear.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-void clear (Geometry &geometry)``
+void clear(Geometry & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/closing_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/closing_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/closing_iterator.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``closing_iterator (Range &range)``
+[[``closing_iterator(Range & range)``
] [Constructor including the range it is based on. ] [[* Range &]: ['range]:
@@ -42,7 +42,7 @@
]]
-[[``closing_iterator (Range &range, bool)``
+[[``closing_iterator(Range & range, bool )``
] [Constructor to indicate the end of a range. ] [[* Range &]: ['range]:
@@ -52,7 +52,7 @@
]]
-[[``closing_iterator ()``
+[[``closing_iterator``
] [Default constructor. ] [
@@ -63,7 +63,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``closing_iterator< Range > & operator= (closing_iterator< Range > const &source)``
+[[``closing_iterator< Range > & operator=(< Range > const & source)``
] [] [[* < Range > const &]: ['source]:
Modified: trunk/libs/geometry/doc/reference/combine.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/combine.qbk (original)
+++ trunk/libs/geometry/doc/reference/combine.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Box, typename Geometry>
-void combine (Box &box, Geometry const &geometry)``
+void combine(Box & box, Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/convert.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convert.qbk (original)
+++ trunk/libs/geometry/doc/reference/convert.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-void convert (Geometry1 const &geometry1, Geometry2 &geometry2)``
+void convert(Geometry1 const & geometry1, Geometry2 & geometry2)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/convex_hull.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convex_hull.qbk (original)
+++ trunk/libs/geometry/doc/reference/convex_hull.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-void convex_hull (Geometry1 const &geometry, Geometry2 &hull)``
+void convex_hull(Geometry1 const & geometry, Geometry2 & hull)``
[heading Parameters]
@@ -51,7 +51,7 @@
[heading Synopsis]
``template<typename Geometry, typename OutputIterator, >
-OutputIterator convex_hull_inserter (Geometry const &geometry, OutputIterator out)``
+OutputIterator convex_hull_inserter(Geometry const & geometry, OutputIterator out)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk (original)
+++ trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -35,7 +35,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void apply (InputGeometry const &geometry, partitions &state) const ``
+[[``void apply(InputGeometry const & geometry, partitions & state)``
] [] [[* InputGeometry const &]: ['geometry]:
@@ -46,7 +46,7 @@
]]
[[``template<typename OutputIterator>
-void result (partitions const &state, OutputIterator out, bool clockwise) const ``
+void result(partitions const & state, OutputIterator out, bool clockwise)``
] [] [[* partitions const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/correct.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/correct.qbk (original)
+++ trunk/libs/geometry/doc/reference/correct.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-void correct (Geometry &geometry)``
+void correct(Geometry & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/difference.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Collection>
-void difference (Geometry1 const &geometry1, Geometry2 const &geometry2, Collection &output_collection)``
+void difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/disjoint.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/disjoint.qbk (original)
+++ trunk/libs/geometry/doc/reference/disjoint.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool disjoint (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+bool disjoint(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/distance.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-distance_result<Geometry1, Geometry2>::type comparable_distance (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+distance_result<Geometry1, Geometry2>::type comparable_distance(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
@@ -51,7 +51,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-distance_result<Geometry1, Geometry2>::type distance (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+distance_result<Geometry1, Geometry2>::type distance(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
@@ -86,7 +86,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Strategy>
-strategy::distance::services::return_type<Strategy>::type distance (Geometry1 const &geometry1, Geometry2 const &geometry2, Strategy const &strategy)``
+strategy::distance::services::return_type<Strategy>::type distance(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/distance_cross_track.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_cross_track.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_cross_track.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -40,13 +40,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``cross_track ()``
+[[``cross_track``
] [] [
]]
-[[``cross_track (return_type const &r)``
+[[``cross_track( const & r)``
] [] [[* const &]: ['r]:
@@ -54,7 +54,7 @@
]]
-[[``cross_track (Strategy const &s)``
+[[``cross_track(Strategy const & s)``
] [] [[* Strategy const &]: ['s]:
@@ -67,7 +67,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``return_type apply (Point const &p, PointOfSegment const &sp1, PointOfSegment const &sp2) const ``
+[[``return_type apply(Point const & p, PointOfSegment const & sp1, PointOfSegment const & sp2)``
] [] [[* Point const &]: ['p]:
@@ -79,7 +79,7 @@
]]
-[[``return_type radius () const ``
+[[``return_type radius``
] [] [
Modified: trunk/libs/geometry/doc/reference/distance_haversine.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_haversine.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_haversine.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -36,7 +36,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``haversine (calculation_type const &radius=1.0)``
+[[``haversine( const & radius)``
] [Constructor. ] [[* const &]: ['radius]: radius of the sphere, defaults to 1.0 for the unit sphere
@@ -49,7 +49,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``calculation_type apply (Point1 const &p1, Point2 const &p2) const ``
+[[``calculation_type apply(Point1 const & p1, Point2 const & p2)``
] [applies the distance calculation ] [[* Point1 const &]: ['p1]: first point
@@ -62,7 +62,7 @@
]]
-[[``calculation_type radius () const ``
+[[``calculation_type radius``
] [access to radius value ] [
Modified: trunk/libs/geometry/doc/reference/distance_projected_point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_projected_point.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_projected_point.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -40,7 +40,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``calculation_type apply (Point const &p, PointOfSegment const &p1, PointOfSegment const &p2) const ``
+[[``calculation_type apply(Point const & p, PointOfSegment const & p1, PointOfSegment const & p2)``
] [] [[* Point const &]: ['p]:
Modified: trunk/libs/geometry/doc/reference/distance_pythagoras.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_pythagoras.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_pythagoras.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -36,7 +36,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``calculation_type apply (Point1 const &p1, Point2 const &p2)``
+[[``calculation_type apply(Point1 const & p1, Point2 const & p2)``
] [applies the distance calculation using pythagoras ] [[* Point1 const &]: ['p1]: first point
Modified: trunk/libs/geometry/doc/reference/envelope.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/envelope.qbk (original)
+++ trunk/libs/geometry/doc/reference/envelope.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry, typename Box>
-void envelope (Geometry const &geometry, Box &mbr)``
+void envelope(Geometry const & geometry, Box & mbr)``
[heading Parameters]
@@ -54,7 +54,7 @@
[heading Synopsis]
``template<typename Box, typename Geometry>
-Box make_envelope (Geometry const &geometry)``
+Box make_envelope(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/equals.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/equals.qbk (original)
+++ trunk/libs/geometry/doc/reference/equals.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool equals (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``ever_circling_iterator (Iterator begin, Iterator end, bool skip_first=false)``
+[[``ever_circling_iterator(Iterator begin, Iterator end, bool skip_first = false)``
] [] [[* Iterator]: ['begin]:
@@ -46,7 +46,7 @@
]]
-[[``ever_circling_iterator (Iterator begin, Iterator end, Iterator start, bool skip_first=false)``
+[[``ever_circling_iterator(Iterator begin, Iterator end, Iterator start, bool skip_first = false)``
] [] [[* Iterator]: ['begin]:
@@ -65,7 +65,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``void moveto (Iterator it)``
+[[``void moveto(Iterator it)``
] [] [[* Iterator]: ['it]:
Modified: trunk/libs/geometry/doc/reference/exterior_ring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/exterior_ring.qbk (original)
+++ trunk/libs/geometry/doc/reference/exterior_ring.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Polygon>
-ring_return_type<Polygon const>::type exterior_ring (Polygon const &polygon)``
+ring_return_type<Polygon const>::type exterior_ring(Polygon const & polygon)``
[heading Parameters]
@@ -50,7 +50,7 @@
[heading Synopsis]
``template<typename Polygon, >
-ring_return_type<Polygon>::type exterior_ring (Polygon &polygon)``
+ring_return_type<Polygon>::type exterior_ring(Polygon & polygon)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/for_each.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/for_each.qbk (original)
+++ trunk/libs/geometry/doc/reference/for_each.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry, typename Functor>
-Functor for_each_point (Geometry &geometry, Functor f)``
+Functor for_each_point(Geometry & geometry, Functor f)``
[heading Parameters]
@@ -48,7 +48,7 @@
[heading Synopsis]
``template<typename Geometry, typename Functor>
-Functor for_each_point (Geometry const &geometry, Functor f)``
+Functor for_each_point(Geometry const & geometry, Functor f)``
[heading Parameters]
@@ -77,7 +77,7 @@
[heading Synopsis]
``template<typename Geometry, typename Functor>
-Functor for_each_segment (Geometry &geometry, Functor f)``
+Functor for_each_segment(Geometry & geometry, Functor f)``
[heading Parameters]
@@ -106,7 +106,7 @@
[heading Synopsis]
``template<typename Geometry, typename Functor>
-Functor for_each_segment (Geometry const &geometry, Functor f)``
+Functor for_each_segment(Geometry const & geometry, Functor f)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/get.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/get.qbk (original)
+++ trunk/libs/geometry/doc/reference/get.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -13,25 +13,66 @@
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__get.xml]
-[section:get get]
+[section:get_2_with_index get (with index)]
-get coordinate value of a Point ( / Sphere)
+get coordinate value of a Box or Segment
+
+[heading Description]
+The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere.
+
+[heading Synopsis]
+``template<std::size_t Index, std::size_t Dimension, typename Geometry>
+coordinate_type<Geometry>::type get(Geometry const & geometry)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[Index] [Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point. ] [ - ] [Must be specified]]
+[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]]
+[[Geometry const &] [Any type fulfilling a Box Concept or a Segment Concept ] [geometry] [A model of the specified concept ]]
+]
+
+
+[heading Returns]
+coordinate value
+
+[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
+`#include <boost/geometry/core/access.hpp>`
+
+[include ref/core/get_box.qbk]
+
+
+[endsect]
+
+[section:get_2 get]
+
+Get coordinate value of a geometry (usually a point).
+
+[heading Description]
+The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere.
[heading Synopsis]
``template<std::size_t Dimension, typename Geometry>
-coordinate_type<Geometry>::type get (Geometry const &geometry)``
+coordinate_type<Geometry>::type get(Geometry const & geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Dimension] [dimension ] [ - ] [Must be specified]]
-[[Geometry const &] [geometry ] [geometry] [geometry to query coordinate value from ]]
+[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]]
+[[Geometry const &] [Any type fulfilling a Geometry Concept (usually a Point Concept) ] [geometry] [A model of the specified concept (usually a point) ]]
]
[heading Returns]
-coordinate value
+The coordinate value of specified dimension of specified geometry [include ref/core/get_point.qbk]
[heading Header]
Either
@@ -54,7 +95,7 @@
[heading Synopsis]
``template<std::size_t Dimension, typename Geometry>
-fp_coordinate_type<Geometry>::type get_as_radian (Geometry const &geometry)``
+fp_coordinate_type<Geometry>::type get_as_radian(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/identity_view.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/identity_view.qbk (original)
+++ trunk/libs/geometry/doc/reference/identity_view.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``identity_view (Range &r)``
+[[``identity_view(Range & r)``
] [] [[* Range &]: ['r]:
@@ -47,25 +47,25 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``const_iterator begin () const ``
+[[``const_iterator begin``
] [] [
]]
-[[``const_iterator end () const ``
+[[``const_iterator end``
] [] [
]]
-[[``iterator begin ()``
+[[``iterator begin``
] [] [
]]
-[[``iterator end ()``
+[[``iterator end``
] [] [
Modified: trunk/libs/geometry/doc/reference/interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/reference/interior_rings.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Polygon>
-interior_return_type<Polygon const>::type interior_rings (Polygon const &polygon)``
+interior_return_type<Polygon const>::type interior_rings(Polygon const & polygon)``
[heading Parameters]
@@ -50,7 +50,7 @@
[heading Synopsis]
``template<typename Polygon>
-interior_return_type<Polygon>::type interior_rings (Polygon &polygon)``
+interior_return_type<Polygon>::type interior_rings(Polygon & polygon)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/intersection.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/intersection.qbk (original)
+++ trunk/libs/geometry/doc/reference/intersection.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename GeometryOut>
-bool intersection (Geometry1 const &geometry1, Geometry2 const &geometry2, GeometryOut &geometry_out)``
+bool intersection(Geometry1 const & geometry1, Geometry2 const & geometry2, GeometryOut & geometry_out)``
[heading Parameters]
@@ -57,7 +57,7 @@
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
-OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out)``
+OutputIterator intersection_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out)``
[heading Parameters]
@@ -90,7 +90,7 @@
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
-OutputIterator intersection_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out, Strategy const &strategy)``
+OutputIterator intersection_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out, Strategy const & strategy)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/intersects.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/intersects.qbk (original)
+++ trunk/libs/geometry/doc/reference/intersects.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool intersects (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+bool intersects(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
@@ -53,7 +53,7 @@
[heading Synopsis]
``template<typename Geometry>
-bool intersects (Geometry const &geometry)``
+bool intersects(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/length.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/length.qbk (original)
+++ trunk/libs/geometry/doc/reference/length.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry, typename Strategy>
-length_result<Geometry>::type length (Geometry const &geometry, Strategy const &strategy)``
+length_result<Geometry>::type length(Geometry const & geometry, Strategy const & strategy)``
[heading Parameters]
@@ -60,7 +60,7 @@
[heading Synopsis]
``template<typename Geometry>
-length_result<Geometry>::type length (Geometry const &geometry)``
+length_result<Geometry>::type length(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/linestring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/linestring.qbk (original)
+++ trunk/libs/geometry/doc/reference/linestring.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,14 +39,14 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``linestring ()``
+[[``linestring``
] [Default constructor, creating an empty linestring. ] [
]]
[[``template<typename Iterator>
-linestring (Iterator begin, Iterator end)``
+linestring(Iterator begin, Iterator end)``
] [Constructor with begin and end, filling the linestring. ] [[* Iterator]: ['begin]:
Modified: trunk/libs/geometry/doc/reference/make.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/make.qbk (original)
+++ trunk/libs/geometry/doc/reference/make.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry, typename T>
-Geometry make (T const &c1, T const &c2, T const &c3)``
+Geometry make(T const & c1, T const & c2, T const & c3)``
[heading Parameters]
@@ -56,7 +56,7 @@
[heading Synopsis]
``template<typename Geometry, typename T, >
-Geometry make (T const &c1, T const &c2)``
+Geometry make(T const & c1, T const & c2)``
[heading Parameters]
@@ -93,7 +93,7 @@
[heading Synopsis]
``template<typename Geometry>
-Geometry make_inverse ()``
+Geometry make_inverse``
[heading Parameters]
@@ -127,7 +127,7 @@
[heading Synopsis]
``template<typename Geometry>
-Geometry make_zero ()``
+Geometry make_zero``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/multi_point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/multi_point.qbk (original)
+++ trunk/libs/geometry/doc/reference/multi_point.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,14 +39,14 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``multi_point ()``
+[[``multi_point``
] [Default constructor, creating an empty multi_point. ] [
]]
[[``template<typename Iterator>
-multi_point (Iterator begin, Iterator end)``
+multi_point(Iterator begin, Iterator end)``
] [Constructor with begin and end, filling the multi_point. ] [[* Iterator]: ['begin]:
Modified: trunk/libs/geometry/doc/reference/num_geometries.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_geometries.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_geometries.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-std::size_t num_geometries (Geometry const &geometry)``
+std::size_t num_geometries(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/num_interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_interior_rings.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-std::size_t num_interior_rings (Geometry const &geometry)``
+std::size_t num_interior_rings(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/num_points.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_points.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_points.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-std::size_t num_points (Geometry const &geometry, bool add_for_open=false)``
+std::size_t num_points(Geometry const & geometry, bool add_for_open)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/overlaps.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/overlaps.qbk (original)
+++ trunk/libs/geometry/doc/reference/overlaps.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool overlaps (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+bool overlaps(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/perimeter.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/perimeter.qbk (original)
+++ trunk/libs/geometry/doc/reference/perimeter.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry, typename Strategy>
-length_result<Geometry>::type perimeter (Geometry const &geometry, Strategy const &strategy)``
+length_result<Geometry>::type perimeter(Geometry const & geometry, Strategy const & strategy)``
[heading Parameters]
@@ -59,7 +59,7 @@
[heading Synopsis]
``template<typename Geometry>
-length_result<Geometry>::type perimeter (Geometry const &geometry)``
+length_result<Geometry>::type perimeter(Geometry const & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point.qbk (original)
+++ trunk/libs/geometry/doc/reference/point.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -42,13 +42,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``point ()``
+[[``point``
] [Default constructor, no initialization. ] [
]]
-[[``point (CoordinateType const &v0, CoordinateType const &v1=0, CoordinateType const &v2=0)``
+[[``point(CoordinateType const & v0, CoordinateType const & v1 = 0, CoordinateType const & v2 = 0)``
] [Constructor to set one, two or three values. ] [[* CoordinateType const &]: ['v0]:
@@ -66,7 +66,7 @@
[table
[[Function] [Description] [Parameters] [Returns]]
[[``template<std::size_t K>
-CoordinateType const & get () const ``
+CoordinateType const & get``
] [Get a coordinate. ] [
@@ -76,7 +76,7 @@
]]
[[``template<std::size_t K>
-void set (CoordinateType const &value)``
+void set(CoordinateType const & value)``
] [Set a coordinate. ] [[* CoordinateType const &]: ['value]: value to set
Modified: trunk/libs/geometry/doc/reference/point_xy.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point_xy.qbk (original)
+++ trunk/libs/geometry/doc/reference/point_xy.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,13 +39,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``point_xy ()``
+[[``point_xy``
] [Default constructor, does not initialize anything. ] [
]]
-[[``point_xy (CoordinateType const &x, CoordinateType const &y)``
+[[``point_xy(CoordinateType const & x, CoordinateType const & y)``
] [Constructor with x/y values. ] [[* CoordinateType const &]: ['x]:
@@ -60,19 +60,19 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``CoordinateType const & x () const ``
+[[``CoordinateType const & x``
] [Get x-value. ] [
]]
-[[``CoordinateType const & y () const ``
+[[``CoordinateType const & y``
] [Get y-value. ] [
]]
-[[``void x (CoordinateType const &v)``
+[[``void x(CoordinateType const & v)``
] [Set x-value. ] [[* CoordinateType const &]: ['v]:
@@ -80,7 +80,7 @@
]]
-[[``void y (CoordinateType const &v)``
+[[``void y(CoordinateType const & v)``
] [Set y-value. ] [[* CoordinateType const &]: ['v]:
Modified: trunk/libs/geometry/doc/reference/polygon.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/polygon.qbk (original)
+++ trunk/libs/geometry/doc/reference/polygon.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -43,31 +43,31 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``ring_type const & outer () const ``
+[[``ring_type const & outer``
] [] [
]]
-[[``inner_container_type const & inners () const ``
+[[``inner_container_type const & inners``
] [] [
]]
-[[``ring_type & outer ()``
+[[``ring_type & outer``
] [] [
]]
-[[``inner_container_type & inners ()``
+[[``inner_container_type & inners``
] [] [
]]
-[[``void clear ()``
+[[``void clear``
] [Utility method, clears outer and inner rings. ] [
Modified: trunk/libs/geometry/doc/reference/referring_segment.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/referring_segment.qbk (original)
+++ trunk/libs/geometry/doc/reference/referring_segment.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -37,7 +37,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``referring_segment (point_type &p1, point_type &p2)``
+[[``referring_segment( & p1, & p2)``
] [] [[* &]: ['p1]:
Modified: trunk/libs/geometry/doc/reference/reverse.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/reverse.qbk (original)
+++ trunk/libs/geometry/doc/reference/reverse.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry>
-void reverse (Geometry &geometry)``
+void reverse(Geometry & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/ring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/ring.qbk (original)
+++ trunk/libs/geometry/doc/reference/ring.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -41,14 +41,14 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``ring ()``
+[[``ring``
] [Default constructor, creating an empty ring. ] [
]]
[[``template<typename Iterator>
-ring (Iterator begin, Iterator end)``
+ring(Iterator begin, Iterator end)``
] [Constructor with begin and end, filling the ring. ] [[* Iterator]: ['begin]:
Modified: trunk/libs/geometry/doc/reference/segment.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -37,13 +37,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``segment ()``
+[[``segment``
] [] [
]]
-[[``segment (Point const &p1, Point const &p2)``
+[[``segment(Point const & p1, Point const & p2)``
] [] [[* Point const &]: ['p1]:
Modified: trunk/libs/geometry/doc/reference/segment_range.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment_range.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment_range.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,7 +34,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``segment_range (Segment const &segment)``
+[[``segment_range(Segment const & segment)``
] [] [[* Segment const &]: ['segment]:
@@ -47,13 +47,13 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``const_iterator begin () const ``
+[[``const_iterator begin``
] [] [
]]
-[[``const_iterator end () const ``
+[[``const_iterator end``
] [] [
Modified: trunk/libs/geometry/doc/reference/segment_range_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment_range_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment_range_iterator.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -34,13 +34,13 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``segment_range_iterator ()``
+[[``segment_range_iterator``
] [] [
]]
-[[``segment_range_iterator (Segment const &segment)``
+[[``segment_range_iterator(Segment const & segment)``
] [] [[* Segment const &]: ['segment]:
@@ -48,7 +48,7 @@
]]
-[[``segment_range_iterator (Segment const &segment, bool)``
+[[``segment_range_iterator(Segment const & segment, bool )``
] [] [[* Segment const &]: ['segment]:
@@ -63,7 +63,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``segment_range_iterator< Segment > & operator= (segment_range_iterator< Segment > const &source)``
+[[``segment_range_iterator< Segment > & operator=(< Segment > const & source)``
] [] [[* < Segment > const &]: ['source]:
Modified: trunk/libs/geometry/doc/reference/set.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/set.qbk (original)
+++ trunk/libs/geometry/doc/reference/set.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -13,21 +13,60 @@
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__set.xml]
-[section:set set]
+[section:set_3_with_index set (with index)]
-set coordinate value of a Point ( / Sphere)
+set coordinate value of a Box / Segment
+
+[heading Description]
+The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere.
+
+[heading Synopsis]
+``template<std::size_t Index, std::size_t Dimension, typename Geometry>
+void set(Geometry & geometry, typename coordinate_type< Geometry >::type const & value)``
+
+[heading Parameters]
+
+[table
+[[Type] [Concept] [Name] [Description] ]
+[[Index] [Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point. ] [ - ] [Must be specified]]
+[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]]
+[[Geometry &] [Any type fulfilling a Box Concept or a Segment Concept ] [geometry] [A model of the specified concept ]]
+[[typename coordinate_type< Geometry >::type const &] [] [value] [The coordinate value to set ]]
+]
+
+
+[heading Header]
+Either
+
+`#include <boost/geometry/geometry.hpp>`
+
+Or
+
+`#include <boost/geometry/core/access.hpp>`
+
+[include ref/core/set_box.qbk]
+
+
+[endsect]
+
+[section:set_3 set]
+
+Set coordinate value of a geometry (usually a point).
+
+[heading Description]
+The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere.
[heading Synopsis]
``template<std::size_t Dimension, typename Geometry>
-void set (Geometry &geometry, typename coordinate_type< Geometry >::type const &value)``
+void set(Geometry & geometry, typename coordinate_type< Geometry >::type const & value)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
-[[Dimension] [dimension ] [ - ] [Must be specified]]
-[[Geometry &] [geometry ] [geometry] [geometry to assign coordinate to ]]
-[[typename coordinate_type< Geometry >::type const &] [] [value] [coordinate value to assign ]]
+[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]]
+[[Geometry &] [Any type fulfilling a Geometry Concept (usually a Point Concept) ] [geometry] [A model of the specified concept (usually a point) ]]
+[[typename coordinate_type< Geometry >::type const &] [] [value] [The coordinate value to set ]]
]
@@ -40,6 +79,8 @@
`#include <boost/geometry/core/access.hpp>`
+[include ref/core/set_point.qbk]
+
[endsect]
@@ -52,7 +93,7 @@
[heading Synopsis]
``template<std::size_t Dimension, typename Geometry>
-void set_from_radian (Geometry &geometry, typename fp_coordinate_type< Geometry >::type const &radians)``
+void set_from_radian(Geometry & geometry, typename fp_coordinate_type< Geometry >::type const & radians)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk (original)
+++ trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -38,7 +38,7 @@
[table
[[Function] [Description] [Parameters] [Returns]]
[[``template<typename P1, typename P2, typename P>
-int apply (P1 const &p1, P2 const &p2, P const &p)``
+int apply(P1 const & p1, P2 const & p2, P const & p)``
] [] [[* P1 const &]: ['p1]:
Modified: trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk (original)
+++ trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -38,7 +38,7 @@
[table
[[Function] [Description] [Parameters] [Returns]]
[[``template<typename P1, typename P2, typename P>
-int apply (P1 const &p1, P2 const &p2, P const &p)``
+int apply(P1 const & p1, P2 const & p2, P const & p)``
] [] [[* P1 const &]: ['p1]:
Modified: trunk/libs/geometry/doc/reference/simplify.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/simplify.qbk (original)
+++ trunk/libs/geometry/doc/reference/simplify.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry, typename Distance>
-void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance)``
+void simplify(Geometry const & geometry, Geometry & out, Distance const & max_distance)``
[heading Parameters]
@@ -51,7 +51,7 @@
[heading Synopsis]
``template<typename Geometry, typename Distance, typename Strategy>
-void simplify (Geometry const &geometry, Geometry &out, Distance const &max_distance, Strategy const &strategy)``
+void simplify(Strategy const & strategy, Geometry const & geometry, Geometry & out, Distance const & max_distance)``
[heading Parameters]
@@ -82,7 +82,7 @@
[heading Synopsis]
``template<typename Geometry, typename OutputIterator, typename Distance>
-void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance)``
+void simplify_inserter(Geometry const & geometry, OutputIterator out, Distance const & max_distance)``
[heading Parameters]
@@ -114,7 +114,7 @@
[heading Synopsis]
``template<typename Geometry, typename OutputIterator, typename Distance, typename Strategy>
-void simplify_inserter (Geometry const &geometry, OutputIterator out, Distance const &max_distance, Strategy const &strategy)``
+void simplify_inserter(Geometry const & geometry, OutputIterator out, Distance const & max_distance, Strategy const & strategy)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk (original)
+++ trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,7 +39,7 @@
[table
[[Function] [Description] [Parameters] [Returns]]
[[``template<typename Range, typename OutputIterator>
-OutputIterator apply (Range const &range, OutputIterator out, double max_distance)``
+OutputIterator apply(Range const & range, OutputIterator out, double max_distance)``
] [] [[* Range const &]: ['range]:
Modified: trunk/libs/geometry/doc/reference/sym_difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/sym_difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/sym_difference.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Collection>
-void sym_difference (Geometry1 const &geometry1, Geometry2 const &geometry2, Collection &output_collection)``
+void sym_difference(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/transform.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool transform (Geometry1 const &geometry1, Geometry2 &geometry2)``
+bool transform(Geometry1 const & geometry1, Geometry2 & geometry2)``
[heading Parameters]
@@ -51,7 +51,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Strategy>
-bool transform (Geometry1 const &geometry1, Geometry2 &geometry2, Strategy const &strategy)``
+bool transform(Geometry1 const & geometry1, Geometry2 & geometry2, Strategy const & strategy)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -37,7 +37,7 @@
[table
[[Function] [Description] [Parameters] ]
[[``template<typename Transformer>
-inverse_transformer (Transformer const &input)``
+inverse_transformer(Transformer const & input)``
] [] [[* Transformer const &]: ['input]:
Modified: trunk/libs/geometry/doc/reference/transform_map_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_map_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_map_transformer.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -41,7 +41,7 @@
[table
[[Function] [Description] [Parameters] ]
[[``template<typename B, typename D>
-map_transformer (B const &box, D const &width, D const &height)``
+map_transformer(B const & box, D const & width, D const & height)``
] [] [[* B const &]: ['box]:
@@ -54,7 +54,7 @@
]]
[[``template<typename W, typename D>
-map_transformer (W const &wx1, W const &wy1, W const &wx2, W const &wy2, D const &width, D const &height)``
+map_transformer(W const & wx1, W const & wy1, W const & wx2, W const & wy2, D const & width, D const & height)``
] [] [[* W const &]: ['wx1]:
Modified: trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -39,7 +39,7 @@
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``rotate_transformer (angle_type const &angle)``
+[[``rotate_transformer(angle_type const & angle)``
] [] [[* angle_type const &]: ['angle]:
Modified: trunk/libs/geometry/doc/reference/union.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/union.qbk (original)
+++ trunk/libs/geometry/doc/reference/union.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -19,7 +19,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Collection>
-void union_ (Geometry1 const &geometry1, Geometry2 const &geometry2, Collection &output_collection)``
+void union_(Geometry1 const & geometry1, Geometry2 const & geometry2, Collection & output_collection)``
[heading Parameters]
@@ -49,7 +49,7 @@
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
-OutputIterator union_inserter (Geometry1 const &geometry1, Geometry2 const &geometry2, OutputIterator out)``
+OutputIterator union_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out)``
[heading Parameters]
@@ -83,7 +83,7 @@
[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)``
+OutputIterator union_inserter(Geometry1 const & geometry1, Geometry2 const & geometry2, OutputIterator out, Strategy const & strategy)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/unique.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/unique.qbk (original)
+++ trunk/libs/geometry/doc/reference/unique.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry>
-void unique (Geometry &geometry)``
+void unique(Geometry & geometry)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/within.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within.qbk (original)
+++ trunk/libs/geometry/doc/reference/within.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -22,7 +22,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Strategy>
-bool within (Geometry1 const &geometry1, Geometry2 const &geometry2, Strategy const &strategy)``
+bool within(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
[heading Parameters]
@@ -63,7 +63,7 @@
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
-bool within (Geometry1 const &geometry1, Geometry2 const &geometry2)``
+bool within(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
Modified: trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -36,7 +36,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``bool apply (Point const &point, PointOfSegment const &seg1, PointOfSegment const &seg2, flags &state)``
+[[``bool apply(Point const & point, PointOfSegment const & seg1, PointOfSegment const & seg2, flags & state)``
] [] [[* Point const &]: ['point]:
@@ -50,7 +50,7 @@
]]
-[[``int result (flags const &state)``
+[[``int result(flags const & state)``
] [] [[* flags const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/within_franklin.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_franklin.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_franklin.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -36,7 +36,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``bool apply (Point const &point, PointOfSegment const &seg1, PointOfSegment const &seg2, crossings &state)``
+[[``bool apply(Point const & point, PointOfSegment const & seg1, PointOfSegment const & seg2, crossings & state)``
] [] [[* Point const &]: ['point]:
@@ -50,7 +50,7 @@
]]
-[[``int result (crossings const &state)``
+[[``int result(crossings const & state)``
] [] [[* crossings const &]: ['state]:
Modified: trunk/libs/geometry/doc/reference/within_winding.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_winding.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_winding.qbk 2011-02-06 16:06:45 EST (Sun, 06 Feb 2011)
@@ -36,7 +36,7 @@
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
-[[``bool apply (Point const &point, PointOfSegment const &s1, PointOfSegment const &s2, counter &state)``
+[[``bool apply(Point const & point, PointOfSegment const & s1, PointOfSegment const & s2, counter & state)``
] [] [[* Point const &]: ['point]:
@@ -50,7 +50,7 @@
]]
-[[``int result (counter const &state)``
+[[``int result(counter const & state)``
] [] [[* counter const &]: ['state]:
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk