equal_to.qbk 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  2. [/ Generated from xml/structboost_1_1geometry_1_1index_1_1equal__to.xml]
  3. [#structboost_1_1geometry_1_1index_1_1equal__to]
  4. [section boost::geometry::index::equal_to]
  5. '''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>equal_to</primary></indexterm>'''
  6. The function object comparing Values.
  7. [heading Description]
  8. The default version handles Values which are Indexables, std::pair<T1, T2>, boost::tuple<...> and std::tuple<...> if STD tuples and variadic templates are supported. All members are compared from left to right, Geometries using boost::geometry::equals() function, other types using operator==.
  9. [heading Header]
  10. `#include <boost/geometry/index/equal_to.hpp>`
  11. [heading Synopsis]
  12. [pre
  13. `template<``typename Value``>`
  14. `struct equal_to`
  15. `{`
  16. ` // ...`
  17. `};`
  18. ]
  19. [heading Template parameter(s)]
  20. [table
  21. [[Parameter] [Description]]
  22. [[`Value`][The type of objects which are compared by this function object. ]]
  23. ]
  24. [heading Typedef(s)]
  25. [table
  26. [[Type] [Description]]
  27. [[[#structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93] `result_type`][The type of result returned by function object. ]]
  28. ]
  29. [heading Member(s)]
  30. [table
  31. [[Modifier][Function][Description]]
  32. [[ `const`][[link structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584 `operator()(Value const &, Value const &)`]][Compare Values. ]]
  33. ]
  34. [#structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584]
  35. [section operator()(Value const &, Value const &)]
  36. '''<indexterm><primary>operator()</primary></indexterm>'''
  37. Compare Values.
  38. [heading Synopsis]
  39. [pre
  40. `bool` `operator()``(``Value const &` `l``,` `Value const &` `r``)`
  41. ]
  42. [heading Modifier(s)]
  43. ``const ``[heading Parameter(s)]
  44. [table
  45. [[Type][Name][Description]]
  46. [[`Value const &`][ `l` ][First value. ]]
  47. [[`Value const &`][ `r` ][Second value. ]]
  48. ]
  49. [heading Returns]
  50. true if Values are equal.
  51. [endsect]
  52. [endsect]