<!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::PDF< _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_1PDF.html">PDF</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> </div>
<div class="headertitle">
<div class="title">ompl::PDF< _T > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::PDF" -->
<p>A container that supports probabilistic sampling over weighted data.
<a href="classompl_1_1PDF.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PDF_8h_source.html">PDF.h</a>></code></p>
<p><a href="classompl_1_1PDF-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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF_1_1Element.html">Element</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A class that will hold data contained in the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. <a href="classompl_1_1PDF_1_1Element.html#details">More...</a><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="ab349a15256996845b0fdb6c52df6f23f"></a><!-- doxytag: member="ompl::PDF::PDF" ref="ab349a15256996845b0fdb6c52df6f23f" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#ab349a15256996845b0fdb6c52df6f23f">PDF</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b46002df3734b53e8340a031ec081cc"></a><!-- doxytag: member="ompl::PDF::PDF" ref="a5b46002df3734b53e8340a031ec081cc" args="(const std::vector< _T > &d, const std::vector< double > &weights)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a5b46002df3734b53e8340a031ec081cc">PDF</a> (const std::vector< _T > &d, const std::vector< double > &weights)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a> containing a given vector of data with given weights. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a203b6148963d65e0074c482ea7213f01"></a><!-- doxytag: member="ompl::PDF::~PDF" ref="a203b6148963d65e0074c482ea7213f01" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a203b6148963d65e0074c482ea7213f01">~PDF</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Clears allocated memory. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4083c1c6e1b2e2579cc8e893446cfac"></a><!-- doxytag: member="ompl::PDF::add" ref="af4083c1c6e1b2e2579cc8e893446cfac" args="(const _T &d, const double w)" -->
<a class="el" href="classompl_1_1PDF_1_1Element.html">Element</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#af4083c1c6e1b2e2579cc8e893446cfac">add</a> (const _T &d, const double w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a piece of data with a given weight to the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. Returns a corresponding <a class="el" href="classompl_1_1PDF_1_1Element.html" title="A class that will hold data contained in the PDF.">Element</a>, which can be used to subsequently update or remove the data from the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f8ee992fa9240d15f10c5782166e6c3"></a><!-- doxytag: member="ompl::PDF::sample" ref="a3f8ee992fa9240d15f10c5782166e6c3" args="(double r) const " -->
const _T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a3f8ee992fa9240d15f10c5782166e6c3">sample</a> (double r) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a piece of data from the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a> according to the input sampling value, which must be between 0 and 1. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66cdb40234cb18c881af2c6e196ae8ae"></a><!-- doxytag: member="ompl::PDF::update" ref="a66cdb40234cb18c881af2c6e196ae8ae" args="(Element &elem, const double w)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a66cdb40234cb18c881af2c6e196ae8ae">update</a> (<a class="el" href="classompl_1_1PDF_1_1Element.html">Element</a> &elem, const double w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates the data in the given <a class="el" href="classompl_1_1PDF_1_1Element.html" title="A class that will hold data contained in the PDF.">Element</a> with a new weight value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf8a49388d14010008aa8aaa7a07c6ef"></a><!-- doxytag: member="ompl::PDF::remove" ref="adf8a49388d14010008aa8aaa7a07c6ef" args="(Element &elem)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#adf8a49388d14010008aa8aaa7a07c6ef">remove</a> (<a class="el" href="classompl_1_1PDF_1_1Element.html">Element</a> &elem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the data in the given <a class="el" href="classompl_1_1PDF_1_1Element.html" title="A class that will hold data contained in the PDF.">Element</a> from the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. After calling this function, the <a class="el" href="classompl_1_1PDF_1_1Element.html" title="A class that will hold data contained in the PDF.">Element</a> object should no longer be used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21f41fc995544c874940fbeb06537665"></a><!-- doxytag: member="ompl::PDF::clear" ref="a21f41fc995544c874940fbeb06537665" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a21f41fc995544c874940fbeb06537665">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8afa9f2a1f14253ada1c8d61d4aef0fe"></a><!-- doxytag: member="ompl::PDF::size" ref="a8afa9f2a1f14253ada1c8d61d4aef0fe" args="(void) const " -->
std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a8afa9f2a1f14253ada1c8d61d4aef0fe">size</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a61ac1ec20e6690ffa33370c95a94d"></a><!-- doxytag: member="ompl::PDF::empty" ref="a78a61ac1ec20e6690ffa33370c95a94d" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a78a61ac1ec20e6690ffa33370c95a94d">empty</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a> contains no data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a122f69b2622ec5708070c111fab2347b"></a><!-- doxytag: member="ompl::PDF::printTree" ref="a122f69b2622ec5708070c111fab2347b" args="(std::ostream &out=std::cout) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1PDF.html#a122f69b2622ec5708070c111fab2347b">printTree</a> (std::ostream &out=std::cout) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the <a class="el" href="classompl_1_1PDF.html" title="A container that supports probabilistic sampling over weighted data.">PDF</a> tree to a given output stream. Used for debugging purposes. <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::PDF< _T ></h3>
<p>A container that supports probabilistic sampling over weighted data. </p>
<p>Definition at line <a class="el" href="PDF_8h_source.html#l00048">48</a> of file <a class="el" href="PDF_8h_source.html">PDF.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="PDF_8h_source.html">PDF.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:31 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
