de9im_matrix.qbk 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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_1de9im_1_1matrix.xml]
  12. [section:de9im_matrix de9im::matrix]
  13. '''<indexterm><primary>de9im</primary></indexterm><indexterm><primary>matrix</primary></indexterm>'''
  14. DE-9IM model intersection matrix.
  15. [heading Description]
  16. This matrix can be used to express spatial relations as defined in Dimensionally Extended 9-Intersection Model.
  17. [heading Synopsis]
  18. ``class de9im::matrix
  19. : public detail::relate::matrix< 3, 3 >
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Constructor(s)]
  25. [table
  26. [[Function] [Description] [Parameters] ]
  27. [[``matrix()``
  28. ] [Initializes all of the matrix elements to F. ] [
  29. ]]
  30. ]
  31. [heading Member Function(s)]
  32. [table
  33. [[Function] [Description] [Parameters] [Returns]]
  34. [[``char operator[](std::size_t index)``
  35. ] [Subscript operator. ] [[* std::size_t]: ['index]: The index of the element
  36. ][
  37. The element
  38. ]
  39. ]
  40. [[``const_iterator begin()``
  41. ] [Returns the iterator to the first element. ] [
  42. ][
  43. const RandomAccessIterator
  44. ]
  45. ]
  46. [[``const_iterator end()``
  47. ] [Returns the iterator past the last element. ] [
  48. ][
  49. const RandomAccessIterator
  50. ]
  51. ]
  52. [[``std::size_t size()``
  53. ] [Returns the number of elements. ] [
  54. ][
  55. 9
  56. ]
  57. ]
  58. [[``const char * data()``
  59. ] [Returns raw pointer to elements. ] [
  60. ][
  61. const pointer to array of elements
  62. ]
  63. ]
  64. [[``std::string str()``
  65. ] [Returns std::string containing elements. ] [
  66. ][
  67. string containing elements
  68. ]
  69. ]
  70. ]
  71. [heading Header]
  72. `#include <boost/geometry/algorithms/detail/relate/de9im.hpp>`
  73. [heading See also]
  74. * [link geometry.reference.algorithms.relation relation]
  75. [endsect]