• 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_1indexable.xml]
3[#structboost_1_1geometry_1_1index_1_1indexable]
4[section boost::geometry::index::indexable]
5
6'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>indexable</primary></indexterm>'''
7The function object extracting Indexable from Value.
8
9[heading Description]
10It translates Value object to Indexable object. By default, it can handle Values which are Indexables, std::pair<Indexable, T2>, boost::tuple<Indexable, ...> and std::tuple<Indexable, ...> if STD tuples and variadic templates are supported.
11
12[heading Header]
13`#include <boost/geometry/index/indexable.hpp>`
14
15[heading Synopsis]
16[pre
17`template<``typename Value``>`
18`struct indexable`
19`{`
20`  // ...`
21`};`
22]
23
24[heading Template parameter(s)]
25[table
26[[Parameter] [Description]]
27[[`Value`][The Value type which may be translated directly to the Indexable. ]]
28]
29
30[heading Typedef(s)]
31[table
32[[Type] [Description]]
33[[[#structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4] `result_type`][The type of result returned by function object. It should be const Indexable reference. ]]
34]
35
36[heading Member(s)]
37[table
38[[Modifier][Function][Description]]
39[[ `const`][[link structboost_1_1geometry_1_1index_1_1indexable_1a0bbe640be9ae0475e1b56f5b2e08877e `operator()(Value const &)`]][Return indexable extracted from the value. ]]
40[[ `const`][[link structboost_1_1geometry_1_1index_1_1indexable_1a4aa66ffe2975f655bada9e6b5a65317b `operator()(V const &)`]][Return indexable extracted from the value. Overload for types compatible with Value but different yet holding referencable Indexable, e.g. tuple containing a reference. ]]
41]
42
43[#structboost_1_1geometry_1_1index_1_1indexable_1a0bbe640be9ae0475e1b56f5b2e08877e]
44[section operator()(Value const &)]
45'''<indexterm><primary>operator()</primary></indexterm>'''
46Return indexable extracted from the value.
47
48[heading Synopsis]
49[pre
50
51[^[link structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4 result_type]] `operator()``(``Value const &` `v``)`
52]
53
54[heading Modifier(s)]
55``const ``[heading Parameter(s)]
56[table
57[[Type][Name][Description]]
58[[`Value const &`][ `v` ][The value. ]]
59]
60[heading Returns]
61The indexable.
62[endsect]
63
64[#structboost_1_1geometry_1_1index_1_1indexable_1a4aa66ffe2975f655bada9e6b5a65317b]
65[section operator()(V const &)]
66'''<indexterm><primary>operator()</primary></indexterm>'''
67Return indexable extracted from the value. Overload for types compatible with Value but different yet holding referencable Indexable, e.g. tuple containing a reference.
68
69[heading Synopsis]
70[pre
71`template<``typename V``>`
72[^[link structboost_1_1geometry_1_1index_1_1indexable_1af6f21324f6484330b9deb0ee0629f4b4 result_type]] `operator()``(``V const &` `v``)`
73]
74
75[heading Modifier(s)]
76``const ``[heading Parameter(s)]
77[table
78[[Type][Name][Description]]
79[[`V const &`][ `v` ][The value. ]]
80]
81[heading Returns]
82The indexable.
83[endsect]
84
85[endsect]
86
87