area_geographic.qbk 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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_1geographic.xml]
  12. [section:strategy_area_geographic strategy::area::geographic]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>area</primary></indexterm><indexterm><primary>geographic</primary></indexterm>'''
  14. Geographic area calculation.
  15. [heading Description]
  16. Geographic area calculation by trapezoidal rule plus integral approximation that gives the ellipsoidal correction
  17. [heading Synopsis]
  18. ``template<typename FormulaPolicy, std::size_t SeriesOrder, typename Spheroid, typename CalculationType>
  19. class strategy::area::geographic
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[typename FormulaPolicy] [strategy::andoyer] [Formula used to calculate azimuths ]]
  28. [[std::size_t SeriesOrder] [strategy::default_order<FormulaPolicy>::value] [The order of approximation of the geodesic integral ]]
  29. [[typename Spheroid] [srs::spheroid<double>] [The spheroid model ]]
  30. [[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 ]]
  31. ]
  32. [heading Constructor(s)]
  33. [table
  34. [[Function] [Description] [Parameters] ]
  35. [[``geographic(Spheroid const & spheroid = Spheroid())``
  36. ] [] [[* Spheroid const &]: ['spheroid]:
  37. ]]
  38. ]
  39. [heading Member Function(s)]
  40. [table
  41. [[Function] [Description] [Parameters] [Returns]]
  42. [[``template<typename PointOfSegment, typename Geometry>
  43. void apply(PointOfSegment const & p1, PointOfSegment const & p2, state< Geometry > & st)``
  44. ] [] [[* PointOfSegment const &]: ['p1]:
  45. [* PointOfSegment const &]: ['p2]:
  46. [* state< Geometry > &]: ['st]:
  47. ][
  48. ]
  49. ]
  50. [[``template<typename Geometry>
  51. result_type< Geometry >::type result(state< Geometry > const & st)``
  52. ] [] [[* state< Geometry > const &]: ['st]:
  53. ][
  54. ]
  55. ]
  56. ]
  57. [heading Header]
  58. `#include <boost/geometry/strategies/geographic/area.hpp>`
  59. [heading See also]
  60. * [link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
  61. * [link geometry.reference.srs.srs_spheroid srs::spheroid]
  62. [endsect]