within_crossings_multiply.qbk 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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_1within_1_1crossings__multiply.xml]
  12. [section:strategy_within_crossings_multiply strategy::within::crossings_multiply]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>within</primary></indexterm><indexterm><primary>crossings_multiply</primary></indexterm>'''
  14. Within detection using cross counting,.
  15. [heading Synopsis]
  16. ``template<typename Point_, typename PointOfSegment_, typename CalculationType, ,
  17. >
  18. class strategy::within::crossings_multiply
  19. {
  20. // ...
  21. };
  22. ``
  23. [heading Template parameter(s)]
  24. [table
  25. [[Parameter] [Default] [Description]]
  26. [[typename Point_] [] []]
  27. [[typename PointOfSegment_] [Point_] []]
  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. [[] [] [Any type fulfilling a Point Concept ]]
  30. [[] [] [segment point type ]]
  31. ]
  32. [heading Member Function(s)]
  33. [table
  34. [[Function] [Description] [Parameters] [Returns]]
  35. [[``template<typename Point, typename PointOfSegment>
  36. bool apply(Point const & point, PointOfSegment const & seg1, PointOfSegment const & seg2,
  37. flags & state)``
  38. ] [] [[* Point const &]: ['point]:
  39. [* PointOfSegment const &]: ['seg1]:
  40. [* PointOfSegment const &]: ['seg2]:
  41. [* flags &]: ['state]:
  42. ][
  43. ]
  44. ]
  45. [[``int result(flags const & state)``
  46. ] [] [[* flags const &]: ['state]:
  47. ][
  48. ]
  49. ]
  50. ]
  51. [heading Header]
  52. `#include <boost/geometry/strategies/cartesian/point_in_poly_crossings_multiply.hpp>`
  53. [endsect]