Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > e7618febbb9cbed15bb79e326774c050 > files > 326

ompl-devel-0.9.5-1.fc14.i686.rpm

<!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::NearestNeighbors&lt; _T &gt; 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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_1NearestNeighbors.html">NearestNeighbors</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ompl::NearestNeighbors&lt; _T &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::NearestNeighbors" -->
<p>Abstract representation of a container that can perform nearest neighbors queries.  
 <a href="classompl_1_1NearestNeighbors.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="NearestNeighbors_8h_source.html">NearestNeighbors.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ompl::NearestNeighbors&lt; _T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classompl_1_1NearestNeighbors__inherit__graph.png" border="0" usemap="#ompl_1_1NearestNeighbors_3_01__T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ompl_1_1NearestNeighbors_3_01__T_01_4_inherit__map" id="ompl_1_1NearestNeighbors_3_01__T_01_4_inherit__map">
<area shape="rect" id="node3" href="classompl_1_1NearestNeighborsGNAT.html" title="Geometric Near&#45;neighbor Access Tree (GNAT), a data structure for nearest neighbor search..." alt="" coords="5,83,243,112"/><area shape="rect" id="node5" href="classompl_1_1NearestNeighborsLinear.html" title="A nearest neighbors datastructure that uses linear search." alt="" coords="267,83,504,112"/><area shape="rect" id="node7" 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="252,160,519,189"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classompl_1_1NearestNeighbors-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a343f54d347b646b65128187e3222f635"></a><!-- doxytag: member="ompl::NearestNeighbors::DistanceFunction" ref="a343f54d347b646b65128187e3222f635" args="" -->
typedef boost::function2<br class="typebreak"/>
&lt; double, const _T &amp;, const _T &amp; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#a343f54d347b646b65128187e3222f635">DistanceFunction</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The definition of a distance function. <br/></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="abb8cd1ac5b87a0a01b27aecab2094d8f"></a><!-- doxytag: member="ompl::NearestNeighbors::setDistanceFunction" ref="abb8cd1ac5b87a0a01b27aecab2094d8f" args="(const DistanceFunction &amp;distFun)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#abb8cd1ac5b87a0a01b27aecab2094d8f">setDistanceFunction</a> (const <a class="el" href="classompl_1_1NearestNeighbors.html#a343f54d347b646b65128187e3222f635">DistanceFunction</a> &amp;distFun)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the distance function to use. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa637f6f51564e09e4e8795ea6b092b86"></a><!-- doxytag: member="ompl::NearestNeighbors::getDistanceFunction" ref="aa637f6f51564e09e4e8795ea6b092b86" args="(void) const " -->
const <a class="el" href="classompl_1_1NearestNeighbors.html#a343f54d347b646b65128187e3222f635">DistanceFunction</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#aa637f6f51564e09e4e8795ea6b092b86">getDistanceFunction</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the distance function used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98e751a93407e17e3bd8dc59317f6f61"></a><!-- doxytag: member="ompl::NearestNeighbors::clear" ref="a98e751a93407e17e3bd8dc59317f6f61" args="(void)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#a98e751a93407e17e3bd8dc59317f6f61">clear</a> (void)=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the datastructure. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdec6e843eb3e2f039df9b5b24ce0ad7"></a><!-- doxytag: member="ompl::NearestNeighbors::add" ref="acdec6e843eb3e2f039df9b5b24ce0ad7" args="(const _T &amp;data)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#acdec6e843eb3e2f039df9b5b24ce0ad7">add</a> (const _T &amp;data)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="aae3c2592a0ef5c64f3bde107c144d70a"></a><!-- doxytag: member="ompl::NearestNeighbors::add" ref="aae3c2592a0ef5c64f3bde107c144d70a" args="(const std::vector&lt; _T &gt; &amp;data)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#aae3c2592a0ef5c64f3bde107c144d70a">add</a> (const std::vector&lt; _T &gt; &amp;data)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a vector of points. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4fcf7cc39c33a4e25e2f7e00b0220c0"></a><!-- doxytag: member="ompl::NearestNeighbors::remove" ref="af4fcf7cc39c33a4e25e2f7e00b0220c0" args="(const _T &amp;data)=0" -->
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#af4fcf7cc39c33a4e25e2f7e00b0220c0">remove</a> (const _T &amp;data)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="af36aec28328e97ba999c51be4f8987c9"></a><!-- doxytag: member="ompl::NearestNeighbors::nearest" ref="af36aec28328e97ba999c51be4f8987c9" args="(const _T &amp;data) const =0" -->
virtual _T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#af36aec28328e97ba999c51be4f8987c9">nearest</a> (const _T &amp;data) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</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="ae3d54c8565ec5ff4f97c31b3d60d5091"></a><!-- doxytag: member="ompl::NearestNeighbors::nearestK" ref="ae3d54c8565ec5ff4f97c31b3d60d5091" args="(const _T &amp;data, std::size_t k, std::vector&lt; _T &gt; &amp;nbh) const =0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#ae3d54c8565ec5ff4f97c31b3d60d5091">nearestK</a> (const _T &amp;data, std::size_t k, std::vector&lt; _T &gt; &amp;nbh) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a473fbd3b00e2eb4aa6b56c767e702e9c"></a><!-- doxytag: member="ompl::NearestNeighbors::nearestR" ref="a473fbd3b00e2eb4aa6b56c767e702e9c" args="(const _T &amp;data, double radius, std::vector&lt; _T &gt; &amp;nbh) const =0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#a473fbd3b00e2eb4aa6b56c767e702e9c">nearestR</a> (const _T &amp;data, double radius, std::vector&lt; _T &gt; &amp;nbh) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a26dad985121585d00395e0a53ae329ea"></a><!-- doxytag: member="ompl::NearestNeighbors::size" ref="a26dad985121585d00395e0a53ae329ea" args="(void) const =0" -->
virtual std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#a26dad985121585d00395e0a53ae329ea">size</a> (void) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</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="ac2d3971a579f748aba6ad2b10f118562"></a><!-- doxytag: member="ompl::NearestNeighbors::list" ref="ac2d3971a579f748aba6ad2b10f118562" args="(std::vector&lt; _T &gt; &amp;data) const =0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#ac2d3971a579f748aba6ad2b10f118562">list</a> (std::vector&lt; _T &gt; &amp;data) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a6f15f3b591fb69b91ca35e504723b54f"></a><!-- doxytag: member="ompl::NearestNeighbors::distFun_" ref="a6f15f3b591fb69b91ca35e504723b54f" args="" -->
<a class="el" href="classompl_1_1NearestNeighbors.html#a343f54d347b646b65128187e3222f635">DistanceFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1NearestNeighbors.html#a6f15f3b591fb69b91ca35e504723b54f">distFun_</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The used distance function. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename _T&gt;<br/>
class ompl::NearestNeighbors&lt; _T &gt;</h3>

<p>Abstract representation of a container that can perform nearest neighbors queries. </p>

<p>Definition at line <a class="el" href="NearestNeighbors_8h_source.html#l00049">49</a> of file <a class="el" href="NearestNeighbors_8h_source.html">NearestNeighbors.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="NearestNeighbors_8h_source.html">NearestNeighbors.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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> &bull;
  <a href="http://www.cs.rice.edu">Department of Computer Science</a> &bull;
  <a href="http://www.rice.edu">Rice University</a><br>
  <div class="gray">Generated on Sun Oct 9 2011 23:04:41 by&#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>