<!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::GreedyKCenters< _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_1GreedyKCenters.html">GreedyKCenters</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">ompl::GreedyKCenters< _T > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::GreedyKCenters" -->
<p>An instance of this class can be used to greedily select a given number of representatives from a set of data points that are all far apart from each other.
<a href="classompl_1_1GreedyKCenters.html#details">More...</a></p>
<p><code>#include <<a class="el" href="GreedyKCenters_8h_source.html">GreedyKCenters.h</a>></code></p>
<p><a href="classompl_1_1GreedyKCenters-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="a244fad14a2118b60ec969d2beb7b0194"></a><!-- doxytag: member="ompl::GreedyKCenters::DistanceFunction" ref="a244fad14a2118b60ec969d2beb7b0194" args="" -->
typedef boost::function2<br class="typebreak"/>
< double, const _T &, const _T & > </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#a244fad14a2118b60ec969d2beb7b0194">DistanceFunction</a></td></tr>
<tr><td class="mdescLeft"> </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="aa46b77a69db20e4c411bbb85956eab21"></a><!-- doxytag: member="ompl::GreedyKCenters::setDistanceFunction" ref="aa46b77a69db20e4c411bbb85956eab21" args="(const DistanceFunction &distFun)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#aa46b77a69db20e4c411bbb85956eab21">setDistanceFunction</a> (const <a class="el" href="classompl_1_1GreedyKCenters.html#a244fad14a2118b60ec969d2beb7b0194">DistanceFunction</a> &distFun)</td></tr>
<tr><td class="mdescLeft"> </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="ad38037a0f3f7c23ce9175e8eedfa5dcd"></a><!-- doxytag: member="ompl::GreedyKCenters::getDistanceFunction" ref="ad38037a0f3f7c23ce9175e8eedfa5dcd" args="(void) const " -->
const <a class="el" href="classompl_1_1GreedyKCenters.html#a244fad14a2118b60ec969d2beb7b0194">DistanceFunction</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#ad38037a0f3f7c23ce9175e8eedfa5dcd">getDistanceFunction</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the distance function used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#a1e1aa026ec5c4833183846fd95ea2b57">kcenters</a> (const std::vector< _T > &data, unsigned int k, std::vector< unsigned int > &centers, std::vector< std::vector< double > > &dists)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Greedy algorithm for selecting k centers. <a href="#a1e1aa026ec5c4833183846fd95ea2b57"></a><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="a4c617a02bb7489b3d1e32261f099f113"></a><!-- doxytag: member="ompl::GreedyKCenters::distFun_" ref="a4c617a02bb7489b3d1e32261f099f113" args="" -->
<a class="el" href="classompl_1_1GreedyKCenters.html#a244fad14a2118b60ec969d2beb7b0194">DistanceFunction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#a4c617a02bb7489b3d1e32261f099f113">distFun_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The used distance function. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classompl_1_1RNG.html">RNG</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1GreedyKCenters.html#a9f9f1e9cacc57cc0a7c1526406cc94dd">rng_</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename _T><br/>
class ompl::GreedyKCenters< _T ></h3>
<p>An instance of this class can be used to greedily select a given number of representatives from a set of data points that are all far apart from each other. </p>
<p>Definition at line <a class="el" href="GreedyKCenters_8h_source.html#l00048">48</a> of file <a class="el" href="GreedyKCenters_8h_source.html">GreedyKCenters.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1e1aa026ec5c4833183846fd95ea2b57"></a><!-- doxytag: member="ompl::GreedyKCenters::kcenters" ref="a1e1aa026ec5c4833183846fd95ea2b57" args="(const std::vector< _T > &data, unsigned int k, std::vector< unsigned int > &centers, std::vector< std::vector< double > > &dists)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classompl_1_1GreedyKCenters.html">ompl::GreedyKCenters</a>< _T >::kcenters </td>
<td>(</td>
<td class="paramtype">const std::vector< _T > & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< unsigned int > & </td>
<td class="paramname"><em>centers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< std::vector< double > > & </td>
<td class="paramname"><em>dists</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Greedy algorithm for selecting k centers. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a vector of data points </td></tr>
<tr><td class="paramname">k</td><td>the desired number of centers </td></tr>
<tr><td class="paramname">centers</td><td>a vector of length k containing the indices into data of the k centers </td></tr>
<tr><td class="paramname">dists</td><td>a 2-dimensional array such that dists[i][j] is the distance between data[i] and data[center[j]] </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="GreedyKCenters_8h_source.html#l00082">82</a> of file <a class="el" href="GreedyKCenters_8h_source.html">GreedyKCenters.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9f9f1e9cacc57cc0a7c1526406cc94dd"></a><!-- doxytag: member="ompl::GreedyKCenters::rng_" ref="a9f9f1e9cacc57cc0a7c1526406cc94dd" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classompl_1_1RNG.html">RNG</a> <a class="el" href="classompl_1_1GreedyKCenters.html">ompl::GreedyKCenters</a>< _T >::<a class="el" href="classompl_1_1GreedyKCenters.html#a9f9f1e9cacc57cc0a7c1526406cc94dd">rng_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Random number generator used to select first center </p>
<p>Definition at line <a class="el" href="GreedyKCenters_8h_source.html#l00126">126</a> of file <a class="el" href="GreedyKCenters_8h_source.html">GreedyKCenters.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/ompl/datastructures/<a class="el" href="GreedyKCenters_8h_source.html">GreedyKCenters.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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
e7618febbb9cbed15bb79e326774c050
>
files
>
309
