<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8"/> <title>OMPL: ompl::NearestNeighborsLinear< _T > Class Template Reference</title> <meta name="author" content="Ioan A. Șucan, Mark Moll, Lydia E. Kavraki"> <link rel="stylesheet" href="../css/screen.css" type="text/css" media="screen, projection"> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print"> <!--[if lt IE 7]> <script type="text/javascript" src="../js/jquery/jquery.js"></script> <script type="text/javascript" src="../js/jquery/jquery.dropdown.js"></script> <![endif]--> <script type="text/javaScript" src="search/search.js"></script> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-9156598-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> </head> <body onload='searchBox.OnSelectItem(0);'> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search API'); --></script> <div class="navigation" id="top"> <div class="tabs" id="ompltitle"> <ul class="tablist"> <li>The Open Motion Planning Library</li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search API" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <ul id="nav" class="dropdown"> <li class="first"><a href="index.html">Home</a></li> <li><a href="download.html">Download</a></li> <li><a href="documentation.html">Documentation</a></li> <li><span class="dir">Code API</span> <ul> <li><a href="api_overview.html">API Overview</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="annotated.html">Classes</a></li> <li><a href="files.html">Files</a></li> <li><a href="dirs.html">Directories</a></li> </ul> </li> <li><span class="dir">Community</span> <ul> <li><a href="developers.html">Developers</a></li> <li><a href="thirdparty.html">Contributions</a></li> <li><a href="education.html">Education</a></li> <li><a href="gallery.html">Gallery</a></li> </ul> </li> <li><span class="dir">About</span> <ul> <li><a href="license.html">License</a></li> <li><a href="citations.html">Citations</a></li> <li><a href="acknowledgements.html">Acknowledgments</a></li> <li><a href="contact.html">Contact Us</a></li> </ul> </li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0"name="MSearchResults" id="MSearchResults"></iframe> </div> <div class="container"> <div class="span-22 push-2 first last"> <div> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceompl.html">ompl</a> </li> <li class="navelem"><a class="el" href="classompl_1_1NearestNeighborsLinear.html">NearestNeighborsLinear</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">ompl::NearestNeighborsLinear< _T > Class Template Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="ompl::NearestNeighborsLinear" --><!-- doxytag: inherits="ompl::NearestNeighbors" --> <p>A nearest neighbors datastructure that uses linear search. <a href="classompl_1_1NearestNeighborsLinear.html#details">More...</a></p> <p><code>#include <<a class="el" href="NearestNeighborsLinear_8h_source.html">NearestNeighborsLinear.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ompl::NearestNeighborsLinear< _T >:</div> <div class="dyncontent"> <div class="center"><img src="classompl_1_1NearestNeighborsLinear__inherit__graph.png" border="0" usemap="#ompl_1_1NearestNeighborsLinear_3_01__T_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="ompl_1_1NearestNeighborsLinear_3_01__T_01_4_inherit__map" id="ompl_1_1NearestNeighborsLinear_3_01__T_01_4_inherit__map"> <area shape="rect" id="node5" href="classompl_1_1NearestNeighborsSqrtApprox.html" title="A nearest neighbors datastructure that uses linear search. The linear search is done over sqrt(n) ele..." alt="" coords="5,160,272,189"/><area shape="rect" id="node2" href="classompl_1_1NearestNeighbors.html" title="Abstract representation of a container that can perform nearest neighbors queries." alt="" coords="37,5,240,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classompl_1_1NearestNeighborsLinear-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>ElemSort</b></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8375fc42d5b46ed740945322cf5c650f"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::clear" ref="a8375fc42d5b46ed740945322cf5c650f" args="(void)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a8375fc42d5b46ed740945322cf5c650f">clear</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the datastructure. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a806e0408ffd272cc56679af0ebf27ec6"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::add" ref="a806e0408ffd272cc56679af0ebf27ec6" args="(const _T &data)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a806e0408ffd272cc56679af0ebf27ec6">add</a> (const _T &data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an element to the datastructure. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8be4e7098a8a42f888e9ec19e64e4ef1"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::add" ref="a8be4e7098a8a42f888e9ec19e64e4ef1" args="(const std::vector< _T > &data)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a8be4e7098a8a42f888e9ec19e64e4ef1">add</a> (const std::vector< _T > &data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a vector of points. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39f7343cae117b245483f663e25bd06c"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::remove" ref="a39f7343cae117b245483f663e25bd06c" args="(const _T &data)" --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a39f7343cae117b245483f663e25bd06c">remove</a> (const _T &data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an element from the datastructure. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af82484d2cc4f469dc6e0456123210ab9"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::nearest" ref="af82484d2cc4f469dc6e0456123210ab9" args="(const _T &data) const " --> virtual _T </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#af82484d2cc4f469dc6e0456123210ab9">nearest</a> (const _T &data) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the nearest neighbor of a point. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae26a7842faa8f914277155185ff82bbf"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::nearestK" ref="ae26a7842faa8f914277155185ff82bbf" args="(const _T &data, std::size_t k, std::vector< _T > &nbh) const " --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#ae26a7842faa8f914277155185ff82bbf">nearestK</a> (const _T &data, std::size_t k, std::vector< _T > &nbh) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the k-nearest neighbors of a point. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a833519244d353b76a0c2e878e8234607"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::nearestR" ref="a833519244d353b76a0c2e878e8234607" args="(const _T &data, double radius, std::vector< _T > &nbh) const " --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a833519244d353b76a0c2e878e8234607">nearestR</a> (const _T &data, double radius, std::vector< _T > &nbh) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the nearest neighbors of a point, within a specified radius. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab03508e91e01f7d300887d3aaa586a64"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::size" ref="ab03508e91e01f7d300887d3aaa586a64" args="(void) const " --> virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#ab03508e91e01f7d300887d3aaa586a64">size</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of elements in the datastructure. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0095b24dbae29d4d051589d8a107ac2"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::list" ref="af0095b24dbae29d4d051589d8a107ac2" args="(std::vector< _T > &data) const " --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#af0095b24dbae29d4d051589d8a107ac2">list</a> (std::vector< _T > &data) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get all the elements in the datastructure. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6af69c36b87793d1004d15b986117182"></a><!-- doxytag: member="ompl::NearestNeighborsLinear::data_" ref="a6af69c36b87793d1004d15b986117182" args="" --> std::vector< _T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighborsLinear.html#a6af69c36b87793d1004d15b986117182">data_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The data elements stored in this structure. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<typename _T><br/> class ompl::NearestNeighborsLinear< _T ></h3> <p>A nearest neighbors datastructure that uses linear search. </p> <ul> <li>Search for nearest neighbor is O(n). </li> <li>Search for k-nearest neighbors is O(n log(k)). </li> <li>Search for neighbors within a range is O(n log(n)). </li> <li>Adding an element to the datastructure is O(1). </li> <li>Removing an element from the datastructure O(n). </li> </ul> <p>Definition at line <a class="el" href="NearestNeighborsLinear_8h_source.html#l00057">57</a> of file <a class="el" href="NearestNeighborsLinear_8h_source.html">NearestNeighborsLinear.h</a>.</p> </div><hr/>The documentation for this class was generated from the following file:<ul> <li>src/ompl/datastructures/<a class="el" href="NearestNeighborsLinear_8h_source.html">NearestNeighborsLinear.h</a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div> <div class="footer span-22 push-2 last"> <a href="http://www.kavrakilab.org">Physical and Biological Computing Group</a> • <a href="http://www.cs.rice.edu">Department of Computer Science</a> • <a href="http://www.rice.edu">Rice University</a><br> <div class="gray">Generated on Sun Oct 9 2011 23:04:41 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div> </div> </div> </body> </html>