Documentation: RobotLocomotion/drake@7b48079

Author: drake-jenkins-bot

doxygen_cxx/classdrake_1_1planning_1_1_common_sampled_iris_options.html

@@ -192,7 +192,7 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 Public Attributes</h2></td></tr>
 <tr class="memitem:acf574bc864f7f0fc111320f1d6c449d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classint.html">int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1_common_sampled_iris_options.html#acf574bc864f7f0fc111320f1d6c449d5">num_particles</a> = 1e3</td></tr>
-<tr class="memdesc:acf574bc864f7f0fc111320f1d6c449d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of particles used to estimate the closest collision.  <a href="#acf574bc864f7f0fc111320f1d6c449d5">More...</a><br /></td></tr>
+<tr class="memdesc:acf574bc864f7f0fc111320f1d6c449d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum number of particles drawn per inner iteration.  <a href="#acf574bc864f7f0fc111320f1d6c449d5">More...</a><br /></td></tr>
 <tr class="separator:acf574bc864f7f0fc111320f1d6c449d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae5f7c26321910a384f6f0d37910858a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1_common_sampled_iris_options.html#ae5f7c26321910a384f6f0d37910858a2">tau</a> = 0.5</td></tr>
 <tr class="memdesc:ae5f7c26321910a384f6f0d37910858a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decision threshold for the unadaptive test.  <a href="#ae5f7c26321910a384f6f0d37910858a2">More...</a><br /></td></tr>
@@ -567,7 +567,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#acf574bc864f7f0fc111320f1
       </table>
 </div><div class="memdoc">
 
-<p>Number of particles used to estimate the closest collision. </p>
+<p>Minimum number of particles drawn per inner iteration. </p>
+<p>Some or all of these particles, depending on the other algorithm settings, will be used to find the closest collisions. </p>
 
 </div>
 </div>

pydrake/pydrake.planning.html

@@ -1712,7 +1712,9 @@
 <dl class="py property">
 <dt class="sig sig-object py" id="pydrake.planning.CommonSampledIrisOptions.num_particles">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">num_particles</span></span><a class="headerlink" href="#pydrake.planning.CommonSampledIrisOptions.num_particles" title="Link to this definition"></a></dt>
-<dd><p>Number of particles used to estimate the closest collision.</p>
+<dd><p>Minimum number of particles drawn per inner iteration. Some or all of
+these particles, depending on the other algorithm settings, will be
+used to find the closest collisions.</p>
 </dd></dl>
 
 <dl class="py property">