side_side_by_cross_track.qbk 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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__cross__track.xml]
  12. [section:strategy_side_side_by_cross_track strategy::side::side_by_cross_track]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>side</primary></indexterm><indexterm><primary>side_by_cross_track</primary></indexterm>'''
  14. Check at which side of a Great Circle 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_cross_track
  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. [[``template<typename P1, typename P2, typename P>
  31. int apply(P1 const & p1, P2 const & p2, P const & p)``
  32. ] [] [[* P1 const &]: ['p1]:
  33. [* P2 const &]: ['p2]:
  34. [* P const &]: ['p]:
  35. ][
  36. ]
  37. ]
  38. ]
  39. [heading Header]
  40. `#include <boost/geometry/strategies/spherical/side_by_cross_track.hpp>`
  41. [endsect]