• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/============================================================================
2  Boost.Geometry (aka GGL, Generic Geometry Library)
3
4  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
5  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
6  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
7
8  Use, modification and distribution is subject to the Boost Software License,
9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13
14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1spherical.xml]
16[section:strategy_area_spherical strategy::area::spherical]
17
18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>area</primary></indexterm><indexterm><primary>spherical</primary></indexterm>'''
19Spherical area calculation.
20
21[heading Description]
22Calculates area on the surface of a sphere using the trapezoidal rule
23
24[heading Synopsis]
25``template<typename RadiusTypeOrSphere, typename CalculationType>
26class strategy::area::spherical
27{
28  // ...
29};
30``
31
32[heading Template parameter(s)]
33[table
34[[Parameter] [Default] [Description]]
35[[typename RadiusTypeOrSphere] [double] [numeric type for radius (of sphere, earth) or sphere model ]]
36[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point]]
37]
38
39[heading Constructor(s)]
40[table
41[[Function] [Description] [Parameters] ]
42[[``spherical()``
43
44] [] [
45
46]]
47[[``template<typename RadiusOrSphere>
48spherical(RadiusOrSphere const & radius_or_sphere)``
49
50] [] [[* RadiusOrSphere const &]: ['radius_or_sphere]:
51
52
53
54]]
55]
56
57[heading Member Function(s)]
58[table
59[[Function] [Description] [Parameters]  [Returns]]
60[[``template<typename PointOfSegment, typename Geometry>
61void apply(PointOfSegment const & p1, PointOfSegment const & p2, state< Geometry > & st)``
62
63] [] [[* PointOfSegment const &]: ['p1]:
64
65[* PointOfSegment const &]: ['p2]:
66
67[* state< Geometry > &]: ['st]:
68
69
70
71][
72
73]
74]
75[[``template<typename Geometry>
76result_type< Geometry >::type result(state< Geometry > const & st)``
77
78] [] [[* state< Geometry > const &]: ['st]:
79
80
81
82][
83
84]
85]
86]
87
88[heading Header]
89`#include <boost/geometry/strategies/spherical/area.hpp>`
90
91[heading See also]
92[link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
93
94[endsect]
95
96