polar.qbk 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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/structboost_1_1geometry_1_1cs_1_1polar.xml]
  12. [section:cs_polar cs::polar]
  13. '''<indexterm><primary>cs</primary></indexterm><indexterm><primary>polar</primary></indexterm>'''
  14. Polar coordinate system.
  15. [heading Description]
  16. Defines the polar coordinate system "in which each point
  17. on a plane is determined by an angle and a distance"
  18. [heading Synopsis]
  19. ``template<typename DegreeOrRadian>
  20. struct cs::polar
  21. : public core_detail::define_angular_units< DegreeOrRadian >
  22. {
  23. // ...
  24. };
  25. ``
  26. [heading Template parameter(s)]
  27. [table
  28. [[Parameter] [Description]]
  29. [[typename DegreeOrRadian] []]
  30. ]
  31. [heading Header]
  32. Either
  33. `#include <boost/geometry.hpp>`
  34. Or
  35. `#include <boost/geometry/core/cs.hpp>`
  36. [endsect]