<!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::base::RealVectorBounds Class 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="namespaceompl_1_1base.html">base</a> </li> <li class="navelem"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html">RealVectorBounds</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">ompl::base::RealVectorBounds Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="ompl::base::RealVectorBounds" --> <p>The lower and upper bounds for an R<sup>n</sup> space. <a href="classompl_1_1base_1_1RealVectorBounds.html#details">More...</a></p> <p><code>#include <<a class="el" href="RealVectorBounds_8h_source.html">RealVectorBounds.h</a>></code></p> <p><a href="classompl_1_1base_1_1RealVectorBounds-members.html">List of all members.</a></p> <table class="memberdecls"> <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="a8da7c7270bda6393663ffcad5a712dff"></a><!-- doxytag: member="ompl::base::RealVectorBounds::RealVectorBounds" ref="a8da7c7270bda6393663ffcad5a712dff" args="(unsigned int dim)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a8da7c7270bda6393663ffcad5a712dff">RealVectorBounds</a> (unsigned int dim)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor; <em>dim</em> represents the dimension of the space these bounds are for. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f63c8d793a056e2160e5d9d85c27a58"></a><!-- doxytag: member="ompl::base::RealVectorBounds::setLow" ref="a6f63c8d793a056e2160e5d9d85c27a58" args="(double value)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a6f63c8d793a056e2160e5d9d85c27a58">setLow</a> (double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the lower bound in each dimension to a specific value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a756253c602ddc6bd299dc9c870fadfee"></a><!-- doxytag: member="ompl::base::RealVectorBounds::setHigh" ref="a756253c602ddc6bd299dc9c870fadfee" args="(double value)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a756253c602ddc6bd299dc9c870fadfee">setHigh</a> (double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the upper bound in each dimension to a specific value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24a3b3bb10acfeda7fabbf25c618fb09"></a><!-- doxytag: member="ompl::base::RealVectorBounds::setLow" ref="a24a3b3bb10acfeda7fabbf25c618fb09" args="(unsigned int index, double value)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a24a3b3bb10acfeda7fabbf25c618fb09">setLow</a> (unsigned int index, double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the lower bound of a dimension to a specific value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2786ec8d6d7683c67e578021ee9fadba"></a><!-- doxytag: member="ompl::base::RealVectorBounds::setHigh" ref="a2786ec8d6d7683c67e578021ee9fadba" args="(unsigned int index, double value)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a2786ec8d6d7683c67e578021ee9fadba">setHigh</a> (unsigned int index, double value)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the upper bound of a dimension to a specific value. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa30e7751da00bb8a108f8dd31dbb9578"></a><!-- doxytag: member="ompl::base::RealVectorBounds::getVolume" ref="aa30e7751da00bb8a108f8dd31dbb9578" args="(void) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#aa30e7751da00bb8a108f8dd31dbb9578">getVolume</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the volume of the space enclosed by the bounds. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92c75bb90f5e6c1594da0cb5cd90e983"></a><!-- doxytag: member="ompl::base::RealVectorBounds::getDifference" ref="a92c75bb90f5e6c1594da0cb5cd90e983" args="(void) const " --> std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a92c75bb90f5e6c1594da0cb5cd90e983">getDifference</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the difference between the high and low bounds for each dimension: result[i] = high[i] - low[i]. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a233cea07153725208456d27459fc8f92"></a><!-- doxytag: member="ompl::base::RealVectorBounds::check" ref="a233cea07153725208456d27459fc8f92" args="(void) const " --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a233cea07153725208456d27459fc8f92">check</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the bounds are valid (same length for low and high, high[i] > low[i]). Throw an exception if this is not the case. <br/></td></tr> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36ebebb6a9e116093581afbd07425baa"></a><!-- doxytag: member="ompl::base::RealVectorBounds::low" ref="a36ebebb6a9e116093581afbd07425baa" args="" --> std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a36ebebb6a9e116093581afbd07425baa">low</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lower bound. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06827561804a768d6ee86a20a664153c"></a><!-- doxytag: member="ompl::base::RealVectorBounds::high" ref="a06827561804a768d6ee86a20a664153c" args="" --> std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1RealVectorBounds.html#a06827561804a768d6ee86a20a664153c">high</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Upper bound. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>The lower and upper bounds for an R<sup>n</sup> space. </p> <p>Definition at line <a class="el" href="RealVectorBounds_8h_source.html#l00048">48</a> of file <a class="el" href="RealVectorBounds_8h_source.html">RealVectorBounds.h</a>.</p> </div><hr/>The documentation for this class was generated from the following files:<ul> <li>src/ompl/base/spaces/<a class="el" href="RealVectorBounds_8h_source.html">RealVectorBounds.h</a></li> <li>src/ompl/base/spaces/src/<a class="el" href="RealVectorBounds_8cpp_source.html">RealVectorBounds.cpp</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>