area_spherical.qbk 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1spherical.xml]
  12. [section:strategy_area_spherical strategy::area::spherical]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>area</primary></indexterm><indexterm><primary>spherical</primary></indexterm>'''
  14. Spherical area calculation.
  15. [heading Description]
  16. Calculates area on the surface of a sphere using the trapezoidal rule
  17. [heading Synopsis]
  18. ``template<typename RadiusTypeOrSphere, typename CalculationType>
  19. class strategy::area::spherical
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[typename RadiusTypeOrSphere] [double] [numeric type for radius (of sphere, earth) or sphere model ]]
  28. [[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]]
  29. ]
  30. [heading Constructor(s)]
  31. [table
  32. [[Function] [Description] [Parameters] ]
  33. [[``spherical()``
  34. ] [] [
  35. ]]
  36. [[``template<typename RadiusOrSphere>
  37. spherical(RadiusOrSphere const & radius_or_sphere)``
  38. ] [] [[* RadiusOrSphere const &]: ['radius_or_sphere]:
  39. ]]
  40. ]
  41. [heading Member Function(s)]
  42. [table
  43. [[Function] [Description] [Parameters] [Returns]]
  44. [[``template<typename PointOfSegment, typename Geometry>
  45. void apply(PointOfSegment const & p1, PointOfSegment const & p2, state< Geometry > & st)``
  46. ] [] [[* PointOfSegment const &]: ['p1]:
  47. [* PointOfSegment const &]: ['p2]:
  48. [* state< Geometry > &]: ['st]:
  49. ][
  50. ]
  51. ]
  52. [[``template<typename Geometry>
  53. result_type< Geometry >::type result(state< Geometry > const & st)``
  54. ] [] [[* state< Geometry > const &]: ['st]:
  55. ][
  56. ]
  57. ]
  58. ]
  59. [heading Header]
  60. `#include <boost/geometry/strategies/spherical/area.hpp>`
  61. [heading See also]
  62. [link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
  63. [endsect]