1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.6"/>
7 <title>Boost.Geometry.Index: boost::geometry::index::indexable< Value > Struct Template Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="search/search.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="search/search.js"></script>
13 <script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
16 <link href="doxygen.css" rel="stylesheet" type="text/css" />
19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
21 <table cellspacing="0" cellpadding="0">
23 <tr style="height: 56px;">
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">Boost.Geometry.Index
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.6 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
37 <div id="navrow1" class="tabs">
39 <li><a href="index.html"><span>Main Page</span></a></li>
40 <li><a href="modules.html"><span>Modules</span></a></li>
41 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
42 <li><a href="files.html"><span>Files</span></a></li>
44 <div id="MSearchBox" class="MSearchBoxInactive">
46 <img id="MSearchSelect" src="search/mag_sel.png"
47 onmouseover="return searchBox.OnSearchSelectShow()"
48 onmouseout="return searchBox.OnSearchSelectHide()"
50 <input type="text" id="MSearchField" value="Search" accesskey="S"
51 onfocus="searchBox.OnSearchFieldFocus(true)"
52 onblur="searchBox.OnSearchFieldFocus(false)"
53 onkeyup="searchBox.OnSearchFieldChange(event)"/>
54 </span><span class="right">
55 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
61 <div id="navrow2" class="tabs2">
63 <li><a href="annotated.html"><span>Class List</span></a></li>
64 <li><a href="classes.html"><span>Class Index</span></a></li>
65 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
66 <li><a href="functions.html"><span>Class Members</span></a></li>
69 <!-- window showing the filter options -->
70 <div id="MSearchSelectWindow"
71 onmouseover="return searchBox.OnSearchSelectShow()"
72 onmouseout="return searchBox.OnSearchSelectHide()"
73 onkeydown="return searchBox.OnSearchSelectKey(event)">
74 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Groups</a></div>
76 <!-- iframe showing the search results (closed by default) -->
77 <div id="MSearchResultsWindow">
78 <iframe src="javascript:void(0)" frameborder="0"
79 name="MSearchResults" id="MSearchResults">
83 <div id="nav-path" class="navpath">
85 <li class="navelem"><b>boost</b></li><li class="navelem"><b>geometry</b></li><li class="navelem"><b>index</b></li><li class="navelem"><a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html">indexable</a></li> </ul>
90 <a href="#pub-types">Public Types</a> |
91 <a href="#pub-methods">Public Member Functions</a> |
92 <a href="structboost_1_1geometry_1_1index_1_1indexable-members.html">List of all members</a> </div>
93 <div class="headertitle">
94 <div class="title">boost::geometry::index::indexable< Value > Struct Template Reference</div> </div>
96 <div class="contents">
98 <p>The function object extracting Indexable from Value.
99 <a href="structboost_1_1geometry_1_1index_1_1indexable.html#details">More...</a></p>
101 <p><code>#include <<a class="el" href="indexable_8hpp_source.html">indexable.hpp</a>></code></p>
102 <div class="dynheader">
103 Inheritance diagram for boost::geometry::index::indexable< Value >:</div>
104 <div class="dyncontent">
106 <img src="structboost_1_1geometry_1_1index_1_1indexable.png" usemap="#boost::geometry::index::indexable< Value >_map" alt=""/>
107 <map id="boost::geometry::index::indexable< Value >_map" name="boost::geometry::index::indexable< Value >_map">
108 <area href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html" alt="boost::geometry::index::detail::indexable< Value >" shape="rect" coords="0,0,289,24"/>
111 <table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
113 Public Types</h2></td></tr>
114 <tr class="memitem:af6f21324f6484330b9deb0ee0629f4b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6f21324f6484330b9deb0ee0629f4b4"></a>
115 typedef <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html">detail::indexable</a><br class="typebreak"/>
116 < Value >::<a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html#af6f21324f6484330b9deb0ee0629f4b4">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html#af6f21324f6484330b9deb0ee0629f4b4">result_type</a></td></tr>
117 <tr class="memdesc:af6f21324f6484330b9deb0ee0629f4b4"><td class="mdescLeft"> </td><td class="mdescRight">The type of result returned by function object. It should be const Indexable reference. <br/></td></tr>
118 <tr class="separator:af6f21324f6484330b9deb0ee0629f4b4"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="inherit_header pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1indexable')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html">boost::geometry::index::detail::indexable< Value ></a></td></tr>
120 <tr class="memitem:a5d9b0405e7f8a0d7596b73bf5fcf7ce9 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d9b0405e7f8a0d7596b73bf5fcf7ce9"></a>
121 typedef Value const & </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html#a5d9b0405e7f8a0d7596b73bf5fcf7ce9">result_type</a></td></tr>
122 <tr class="memdesc:a5d9b0405e7f8a0d7596b73bf5fcf7ce9 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="mdescLeft"> </td><td class="mdescRight">The type of result returned by function object. <br/></td></tr>
123 <tr class="separator:a5d9b0405e7f8a0d7596b73bf5fcf7ce9 inherit pub_types_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="memSeparator" colspan="2"> </td></tr>
124 </table><table class="memberdecls">
125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
126 Public Member Functions</h2></td></tr>
127 <tr class="memitem:afa5f2cdc3390a6f1f394890e479df794"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html#af6f21324f6484330b9deb0ee0629f4b4">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html#afa5f2cdc3390a6f1f394890e479df794">operator()</a> (Value const &v) const </td></tr>
128 <tr class="memdesc:afa5f2cdc3390a6f1f394890e479df794"><td class="mdescLeft"> </td><td class="mdescRight">Return indexable extracted from the value. <a href="#afa5f2cdc3390a6f1f394890e479df794">More...</a><br/></td></tr>
129 <tr class="separator:afa5f2cdc3390a6f1f394890e479df794"><td class="memSeparator" colspan="2"> </td></tr>
130 <tr class="inherit_header pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1indexable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html">boost::geometry::index::detail::indexable< Value ></a></td></tr>
131 <tr class="memitem:ae3140efa415e00f13a57e17b3438f30c inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html#a5d9b0405e7f8a0d7596b73bf5fcf7ce9">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1index_1_1detail_1_1indexable.html#ae3140efa415e00f13a57e17b3438f30c">operator()</a> (Value const &v) const</td></tr>
132 <tr class="memdesc:ae3140efa415e00f13a57e17b3438f30c inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="mdescLeft"> </td><td class="mdescRight">Return indexable extracted from the value. <a href="#ae3140efa415e00f13a57e17b3438f30c">More...</a><br/></td></tr>
133 <tr class="separator:ae3140efa415e00f13a57e17b3438f30c inherit pub_methods_structboost_1_1geometry_1_1index_1_1detail_1_1indexable"><td class="memSeparator" colspan="2"> </td></tr>
135 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
136 <div class="textblock"><h3>template<typename Value><br/>
137 struct boost::geometry::index::indexable< Value ></h3>
139 <p>The function object extracting Indexable from Value. </p>
140 <p>It 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.</p>
141 <dl class="tparams"><dt>Template Parameters</dt><dd>
142 <table class="tparams">
143 <tr><td class="paramname">Value</td><td>The Value type which may be translated directly to the Indexable. </td></tr>
147 </div><h2 class="groupheader">Member Function Documentation</h2>
148 <a class="anchor" id="afa5f2cdc3390a6f1f394890e479df794"></a>
149 <div class="memitem">
150 <div class="memproto">
151 <div class="memtemplate">
152 template<typename Value > </div>
153 <table class="mlabels">
155 <td class="mlabels-left">
156 <table class="memname">
158 <td class="memname"><a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html#af6f21324f6484330b9deb0ee0629f4b4">result_type</a> <a class="el" href="structboost_1_1geometry_1_1index_1_1indexable.html">boost::geometry::index::indexable</a>< Value >::operator() </td>
160 <td class="paramtype">Value const & </td>
161 <td class="paramname"><em>v</em></td><td>)</td>
166 <td class="mlabels-right">
167 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
170 </div><div class="memdoc">
172 <p>Return indexable extracted from the value. </p>
173 <dl class="params"><dt>Parameters</dt><dd>
174 <table class="params">
175 <tr><td class="paramname">v</td><td>The value. </td></tr>
179 <dl class="section return"><dt>Returns</dt><dd>The indexable. </dd></dl>
183 <hr/>The documentation for this struct was generated from the following file:<ul>
184 <li>/home/ubuntu/boost/boost/geometry/index/<a class="el" href="indexable_8hpp_source.html">indexable.hpp</a></li>
186 </div><!-- contents -->
187 <!-- start footer part -->
188 <hr class="footer"/><address class="footer"><small>
189 Generated on Thu Dec 22 2016 12:40:17 for Boost.Geometry.Index by  <a href="http://www.doxygen.org/index.html">
190 <img class="footer" src="doxygen.png" alt="doxygen"/>