<!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::Benchmark::CompleteExperiment Struct 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_1Benchmark.html">Benchmark</a> </li> <li class="navelem"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html">CompleteExperiment</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">ompl::Benchmark::CompleteExperiment Struct Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="ompl::Benchmark::CompleteExperiment" --> <p>This structure holds experimental data for a set of planners. <a href="structompl_1_1Benchmark_1_1CompleteExperiment.html#details">More...</a></p> <p><code>#include <<a class="el" href="Benchmark_8h_source.html">Benchmark.h</a>></code></p> <p><a href="structompl_1_1Benchmark_1_1CompleteExperiment-members.html">List of all members.</a></p> <table class="memberdecls"> <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="af259d4ec153ce9982713d81109e678ae"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::name" ref="af259d4ec153ce9982713d81109e678ae" args="" --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#af259d4ec153ce9982713d81109e678ae">name</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the experiment. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5857729d9d13aee0dc94953d4512a4ed"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::planners" ref="a5857729d9d13aee0dc94953d4512a4ed" args="" --> std::vector< <a class="el" href="structompl_1_1Benchmark_1_1PlannerExperiment.html">PlannerExperiment</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#a5857729d9d13aee0dc94953d4512a4ed">planners</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The collected experimental data; each element of the array (an experiment) corresponds to a planner. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa02186a75918287ddc6be7294f95b89e"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::maxTime" ref="aa02186a75918287ddc6be7294f95b89e" args="" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#aa02186a75918287ddc6be7294f95b89e">maxTime</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum allowed time for planner computation during the experiment (seconds) <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac46037ec4d9200b679ca5a2318cca2cb"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::maxMem" ref="ac46037ec4d9200b679ca5a2318cca2cb" args="" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#ac46037ec4d9200b679ca5a2318cca2cb">maxMem</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum allowed memory for planner computation during the experiment (MB) <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b157a32f7b3a2d1f06bab8e703f837c"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::startTime" ref="a0b157a32f7b3a2d1f06bab8e703f837c" args="" --> <a class="el" href="namespaceompl_1_1time.html#a9f28e947d7e95cfa5f0790ccdb7f0953">time::point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#a0b157a32f7b3a2d1f06bab8e703f837c">startTime</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The point in time when the experiment was started. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e0f5aba984640f904ecedc2802fba38"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::totalDuration" ref="a9e0f5aba984640f904ecedc2802fba38" args="" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#a9e0f5aba984640f904ecedc2802fba38">totalDuration</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The amount of time spent to collect the information in this structure (seconds) <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a2cb466da0711deac5aebccaa2bad12"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::setupInfo" ref="a7a2cb466da0711deac5aebccaa2bad12" args="" --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#a7a2cb466da0711deac5aebccaa2bad12">setupInfo</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The output of SimpleSetup::print() before the experiment was started. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5534125efb2a3a52d658b41aa732ecd"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::seed" ref="aa5534125efb2a3a52d658b41aa732ecd" args="" --> boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#aa5534125efb2a3a52d658b41aa732ecd">seed</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The random seed that was used at the start of the benchmark program. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4f08327b24fbdb1171e4a07276e99b5"></a><!-- doxytag: member="ompl::Benchmark::CompleteExperiment::host" ref="ad4f08327b24fbdb1171e4a07276e99b5" args="" --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structompl_1_1Benchmark_1_1CompleteExperiment.html#ad4f08327b24fbdb1171e4a07276e99b5">host</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Hostname that identifies the machine the benchmark ran on. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>This structure holds experimental data for a set of planners. </p> <p>Definition at line <a class="el" href="Benchmark_8h_source.html#l00101">101</a> of file <a class="el" href="Benchmark_8h_source.html">Benchmark.h</a>.</p> </div><hr/>The documentation for this struct was generated from the following file:<ul> <li>src/ompl/tools/benchmark/<a class="el" href="Benchmark_8h_source.html">Benchmark.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>