boost/libs/geometry/doc/generated/area_spherical.qbk

[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  Copyright (c) 2009-2013 Mateusz Loskot, 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)
=============================================================================/]


[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1spherical.xml]
[section:strategy_area_spherical strategy::area::spherical]

'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>area</primary></indexterm><indexterm><primary>spherical</primary></indexterm>'''
Spherical area calculation. 

[heading Description]
Calculates area on the surface of a sphere using the trapezoidal rule 

[heading Synopsis]
``template<typename RadiusTypeOrSphere, typename CalculationType>
class strategy::area::spherical
{
  // ...
};
``

[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[typename RadiusTypeOrSphere] [double] [numeric type for radius (of sphere, earth) or sphere model ]]
[[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]]
]

[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``spherical()``

] [] [

]]
[[``template<typename RadiusOrSphere>
spherical(RadiusOrSphere const & radius_or_sphere)``

] [] [[* RadiusOrSphere const &]: ['radius_or_sphere]:  



]]
]

[heading Member Function(s)]
[table
[[Function] [Description] [Parameters]  [Returns]]
[[``template<typename PointOfSegment, typename Geometry>
void apply(PointOfSegment const & p1, PointOfSegment const & p2, state< Geometry > & st)``

] [] [[* PointOfSegment const &]: ['p1]:  

[* PointOfSegment const &]: ['p2]:  

[* state< Geometry > &]: ['st]:  



][

]
]
[[``template<typename Geometry>
result_type< Geometry >::type result(state< Geometry > const & st)``

] [] [[* state< Geometry > const &]: ['st]:  



][

]
]
[[``srs::sphere< radius_type > model()``

] [] [

][

]
]
]

[heading Header]
`#include <boost/geometry/strategy/spherical/area.hpp>`

[heading See also]
[link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]

[endsect]