• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
6'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>equal_to</primary></indexterm>'''
7The function object comparing Values.
8
9[heading Description]
10The 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==.
11
12[heading Header]
13`#include <boost/geometry/index/equal_to.hpp>`
14
15[heading Synopsis]
16[pre
17`template<``typename Value``>`
18`struct equal_to`
19`{`
20`  // ...`
21`};`
22]
23
24[heading Template parameter(s)]
25[table
26[[Parameter] [Description]]
27[[`Value`][The type of objects which are compared by this function object. ]]
28]
29
30[heading Typedef(s)]
31[table
32[[Type] [Description]]
33[[[#structboost_1_1geometry_1_1index_1_1equal__to_1ae6a986988e380c2ba4afa646294cfd93] `result_type`][The type of result returned by function object. ]]
34]
35
36[heading Member(s)]
37[table
38[[Modifier][Function][Description]]
39[[ `const`][[link structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584 `operator()(Value const &, Value const &)`]][Compare Values. ]]
40]
41
42[#structboost_1_1geometry_1_1index_1_1equal__to_1aaeece0d0d4cc09ee939b85db0c08b584]
43[section operator()(Value const &, Value const &)]
44'''<indexterm><primary>operator()</primary></indexterm>'''
45Compare Values.
46
47[heading Synopsis]
48[pre
49
50`bool` `operator()``(``Value const &` `l``,` `Value const &` `r``)`
51]
52
53[heading Modifier(s)]
54``const ``[heading Parameter(s)]
55[table
56[[Type][Name][Description]]
57[[`Value const &`][ `l` ][First value. ]]
58[[`Value const &`][ `r` ][Second value. ]]
59]
60[heading Returns]
61true if Values are equal.
62[endsect]
63
64[endsect]
65
66