area_cartesian.qbk 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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_1cartesian.xml]
  12. [section:strategy_area_cartesian strategy::area::cartesian]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>area</primary></indexterm><indexterm><primary>cartesian</primary></indexterm>'''
  14. Cartesian area calculation.
  15. [heading Description]
  16. Calculates cartesian area using the trapezoidal rule
  17. [heading Synopsis]
  18. ``template<typename CalculationType>
  19. class strategy::area::cartesian
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[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]]
  28. ]
  29. [heading Member Function(s)]
  30. [table
  31. [[Function] [Description] [Parameters] [Returns]]
  32. [[``template<typename PointOfSegment, typename Geometry>
  33. void apply(PointOfSegment const & p1, PointOfSegment const & p2, state< Geometry > & st)``
  34. ] [] [[* PointOfSegment const &]: ['p1]:
  35. [* PointOfSegment const &]: ['p2]:
  36. [* state< Geometry > &]: ['st]:
  37. ][
  38. ]
  39. ]
  40. [[``template<typename Geometry>
  41. result_type< Geometry >::type result(state< Geometry > & st)``
  42. ] [] [[* state< Geometry > &]: ['st]:
  43. ][
  44. ]
  45. ]
  46. ]
  47. [heading Header]
  48. `#include <boost/geometry/strategies/cartesian/area.hpp>`
  49. [heading See also]
  50. [link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
  51. [endsect]