side_side_by_triangle.qbk 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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_1side_1_1side__by__triangle.xml]
  12. [section:strategy_side_side_by_triangle strategy::side::side_by_triangle]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>side</primary></indexterm><indexterm><primary>side_by_triangle</primary></indexterm>'''
  14. Check at which side of a segment a point lies: left of segment (> 0), right of segment (< 0), on segment (0)
  15. [heading Synopsis]
  16. ``template<typename CalculationType>
  17. class strategy::side::side_by_triangle
  18. {
  19. // ...
  20. };
  21. ``
  22. [heading Template parameter(s)]
  23. [table
  24. [[Parameter] [Default] [Description]]
  25. [[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 ]]
  26. ]
  27. [heading Member Function(s)]
  28. [table
  29. [[Function] [Description] [Parameters] [Returns]]
  30. [[``envelope_strategy_type get_envelope_strategy()``
  31. ] [] [
  32. ][
  33. ]
  34. ]
  35. [[``disjoint_strategy_type get_disjoint_strategy()``
  36. ] [] [
  37. ][
  38. ]
  39. ]
  40. [[``equals_point_point_strategy_type get_equals_point_point_strategy()``
  41. ] [] [
  42. ][
  43. ]
  44. ]
  45. [[``template<typename CoordinateType, typename PromotedType, typename P1, typename P2,
  46. typename P, typename EpsPolicy>
  47. PromotedType side_value(P1 const & p1, P2 const & p2, P const & p,
  48. EpsPolicy & eps_policy)``
  49. ] [] [[* P1 const &]: ['p1]:
  50. [* P2 const &]: ['p2]:
  51. [* P const &]: ['p]:
  52. [* EpsPolicy &]: ['eps_policy]:
  53. ][
  54. ]
  55. ]
  56. [[``template<typename CoordinateType, typename PromotedType, typename P1, typename P2,
  57. typename P>
  58. PromotedType side_value(P1 const & p1, P2 const & p2, P const & p)``
  59. ] [] [[* P1 const &]: ['p1]:
  60. [* P2 const &]: ['p2]:
  61. [* P const &]: ['p]:
  62. ][
  63. ]
  64. ]
  65. [[``template<typename P1, typename P2, typename P>
  66. int apply(P1 const & p1, P2 const & p2, P const & p)``
  67. ] [] [[* P1 const &]: ['p1]:
  68. [* P2 const &]: ['p2]:
  69. [* P const &]: ['p]:
  70. ][
  71. ]
  72. ]
  73. ]
  74. [heading Header]
  75. `#include <boost/geometry/strategies/cartesian/side_by_triangle.hpp>`
  76. [endsect]