Documentation: RobotLocomotion/drake@6e23501

Author: drake-jenkins-bot

doxygen_cxx/annotated.html

@@ -452,7 +452,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a90d3862b7dcabae5f69c38a1
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">resource_path</td><td>the value passed to FindResource </td></tr>
-    <tr><td class="paramname">base_path</td><td>an absolute base path that precedes resource_path </td></tr>
+    <tr><td class="paramname">absolute_path</td><td>an absolute base path that precedes resource_path </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/classdrake_1_1_find_resource_result.html

@@ -170,7 +170,7 @@
 
 <p>A smart pointer with deep copy semantics. </p>
 <p>This is <em>similar</em> to <code>std::unique_ptr</code> in that it does not permit shared ownership of the contained object. However, unlike <code>std::unique_ptr</code>, copyable_unique_ptr supports copy and assignment operations, by insisting that the contained object be "copyable". To be copyable, the class must have either an accessible copy constructor, or it must have an accessible clone method with signature</p><div class="fragment"><div class="line">std::unique_ptr&lt;Foo&gt; Clone() <span class="keyword">const</span>;</div></div><!-- fragment --><p> where Foo is the type of the managed object. By "accessible" we mean either that the copy constructor or clone method is public, or <code>friend <a class="el" href="classdrake_1_1copyable__unique__ptr.html" title="A smart pointer with deep copy semantics.">copyable_unique_ptr</a>&lt;Foo&gt;;</code> appears in Foo's class declaration.</p>
-<p>Generally, the API is modeled as closely as possible on the C++ standard <code>std::unique_ptr</code> API and copyable_unique_ptr&lt;T&gt; is interoperable with <code>unique_ptr&lt;T&gt;</code> wherever that makes sense. However, there are some differences:</p>
+<p>Generally, the API is modeled as closely as possible on the C++ standard <code>std::unique_ptr</code> API and copyable_unique_ptr is interoperable with <code>unique_ptr&lt;T&gt;</code> wherever that makes sense. However, there are some differences:</p>
 <ol type="1">
 <li>It always uses a default deleter.</li>
 <li>There is no array version.</li>

doxygen_cxx/classdrake_1_1copyable__unique__ptr.html

@@ -1816,7 +1816,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a29150974d6cae8767ab9705c
     <tr><td class="paramname">model_path</td><td>Full path to the model file. </td></tr>
     <tr><td class="paramname">iiwa_instance</td><td>Identifies the IIWA model. </td></tr>
     <tr><td class="paramname">parent_frame</td><td>Identifies frame P (the parent frame) in the MultibodyPlant that the IIWA model has been attached to. </td></tr>
-    <tr><td class="paramname">child_frame_name</td><td>Identifies frame C (the child frame) in the IIWA model that is welded to frame P. </td></tr>
+    <tr><td class="paramname">child_frame</td><td>Identifies frame C (the child frame) in the IIWA model that is welded to frame P. </td></tr>
     <tr><td class="paramname">X_PC</td><td>Transformation between frame P and C. </td></tr>
   </table>
   </dd>
@@ -2024,7 +2024,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a939e02a4c7fa69236f4a7384
 <p>Sets the default State for the chosen setup. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">context</td><td>A const reference to the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> context. </td></tr>
+    <tr><td class="paramname">station_context</td><td>A const reference to the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> context. </td></tr>
     <tr><td class="paramname">state</td><td>A pointer to the State of the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> system. </td></tr>
   </table>
   </dd>
@@ -2186,7 +2186,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aac57ec44b7ab08cc19654862
 </div><div class="memdoc">
 
 <p>Convenience method for setting all of the joint velocities of the Kuka IIWA. </p>
-<p>@v must have size <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html#a15f05a3d7f23b3fc83e67dace06d49c5" title="Gets the number of joints in the IIWA (only – does not include the gripper).">num_iiwa_joints()</a>. </p><dl class="section pre"><dt>Precondition</dt><dd><code>state</code> must be the systems::State&lt;T&gt; object contained in <code>station_context</code>. </dd></dl>
+<p><code>v</code> must have size <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html#a15f05a3d7f23b3fc83e67dace06d49c5" title="Gets the number of joints in the IIWA (only – does not include the gripper).">num_iiwa_joints()</a>. </p><dl class="section pre"><dt>Precondition</dt><dd><code>state</code> must be the systems::State&lt;T&gt; object contained in <code>station_context</code>. </dd></dl>
 
 </div>
 </div>
@@ -2217,7 +2217,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a543cb365d7ffcdeb83514173
 </div><div class="memdoc">
 
 <p>Convenience method for setting all of the joint velocities of the Kuka IIWA. </p>
-<p>@v must have size <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html#a15f05a3d7f23b3fc83e67dace06d49c5" title="Gets the number of joints in the IIWA (only – does not include the gripper).">num_iiwa_joints()</a>. </p>
+<p><code>v</code> must have size <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html#a15f05a3d7f23b3fc83e67dace06d49c5" title="Gets the number of joints in the IIWA (only – does not include the gripper).">num_iiwa_joints()</a>. </p>
 
 </div>
 </div>
@@ -2290,7 +2290,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2e9db3943f27de4b8fc28a93
 <p>Sets a random State for the chosen setup. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">context</td><td>A const reference to the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> context. </td></tr>
+    <tr><td class="paramname">station_context</td><td>A const reference to the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> context. </td></tr>
     <tr><td class="paramname">state</td><td>A pointer to the State of the <a class="el" href="classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html" title="A system that represents the complete manipulation station, including exactly one robotic arm (a Kuka...">ManipulationStation</a> system. </td></tr>
     <tr><td class="paramname">generator</td><td>is the random number generator. </td></tr>
   </table>

doxygen_cxx/classdrake_1_1examples_1_1manipulation__station_1_1_manipulation_station.html

@@ -1292,7 +1292,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af8f8b5588e24a899b6aec5b0
 <p>Constructor. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">num_joints</td><td>The total number of fingers used on the planar-gripper. </td></tr>
+    <tr><td class="paramname">num_fingers</td><td>The total number of fingers used on the planar-gripper. </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/classdrake_1_1examples_1_1planar__gripper_1_1_gripper_command_encoder.html

@@ -1292,7 +1292,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a75e91651c3cff6e58b91b5dc
 <p>Constructor. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">num_joints</td><td>The total number of fingers used on the planar-gripper. </td></tr>
+    <tr><td class="paramname">num_fingers</td><td>The total number of fingers used on the planar-gripper. </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/classdrake_1_1examples_1_1planar__gripper_1_1_gripper_status_encoder.html

@@ -437,13 +437,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa4e072198684b3b69292aaa1
 <p>We can reformulate (2a) as the following constraint ⌈aᵀp_AS + b aᵀ⌉ is psd. (3) ⌊ a (aᵀp_AS + b)/r²*I₃⌋ (3) is equivalent to the rational ⌈1⌉ᵀ*⌈aᵀp_AS + b aᵀ⌉*⌈1⌉ ⌊y⌋ ⌊ a (aᵀp_AS+ b)/r²*I₃⌋ ⌊y⌋ is positive.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">a</td><td>The normal vector in the separating plane. a is expressed in frame A. Note that <code>a</code> doesn't need to have a unit length. </td></tr>
-    <tr><td class="paramname">b</td><td>The constant term in the separating plane. </td></tr>
-    <tr><td class="paramname">X_AB_multilinear</td><td>The pose of the collision geometry body (B) in the expressed frame A, written as a multilinear polynomial. This quantity is generated from RationalForwardKinematics::CalcBodyPoseAsMultilinearPolynomial. </td></tr>
-    <tr><td class="paramname">rational_forward_kin</td><td>This object is constructed with the MultibodyPlant containing this collision geometry. </td></tr>
-    <tr><td class="paramname">plane_side</td><td>Whether the geometry is on the positive or negative side of the plane. </td></tr>
-    <tr><td class="paramname">y_slack</td><td>The slack variable y in the documentation above, used for non-polytopic geometries. For spheres and capsules, y_slack has size 3. For cylinders, y_slack has size 2. </td></tr>
-    <tr><td class="paramname">[in/out]</td><td>rationals We append new rational functions to <code>rationals</code>. If these new rational functions are positive, then the geometry is on a given side of the plane. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">a</td><td>The normal vector in the separating plane. a is expressed in frame A. Note that <code>a</code> doesn't need to have a unit length. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">b</td><td>The constant term in the separating plane. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">X_AB_multilinear</td><td>The pose of the collision geometry body (B) in the expressed frame A, written as a multilinear polynomial. This quantity is generated from RationalForwardKinematics::CalcBodyPoseAsMultilinearPolynomial. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">rational_forward_kin</td><td>This object is constructed with the MultibodyPlant containing this collision geometry. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">plane_side</td><td>Whether the geometry is on the positive or negative side of the plane. </td></tr>
+    <tr><td class="paramdir"></td><td class="paramname">y_slack</td><td>The slack variable y in the documentation above, used for non-polytopic geometries. For spheres and capsules, y_slack has size 3. For cylinders, y_slack has size 2. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">rationals</td><td>We append new rational functions to <code>rationals</code>. If these new rational functions are positive, then the geometry is on a given side of the plane. </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/classdrake_1_1geometry_1_1optimization_1_1_c_iris_collision_geometry.html

@@ -1244,7 +1244,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aaacbd0a682d985194c7d94d6
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">points</td><td>are the points which we wish to project to the convex set. </td></tr>
-    <tr><td class="paramdir"></td><td class="paramname">[in/out]</td><td>projected_points are the projection of <code>points</code> onto the convex set. </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">projected_points</td><td>are the projection of <code>points</code> onto the convex set. </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/classdrake_1_1geometry_1_1optimization_1_1_convex_set.html

@@ -402,7 +402,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a34a9db3ba8b38c63a5229888
 <p>Adds a constraint to this edge. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">bindings</td><td>must contain <em>only</em> elements of <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_edge.html#aeacbc2abb655b394b863536ddcd78036" title="Returns the continuous decision variables associated with vertex u.">xu()</a> and <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_edge.html#a09f1477bfa664da452fb472f7c1959cc" title="Returns the continuous decision variables associated with vertex v.">xv()</a> as variables. </td></tr>
+    <tr><td class="paramname">binding</td><td>must contain <em>only</em> elements of <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_edge.html#aeacbc2abb655b394b863536ddcd78036" title="Returns the continuous decision variables associated with vertex u.">xu()</a> and <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_edge.html#a09f1477bfa664da452fb472f7c1959cc" title="Returns the continuous decision variables associated with vertex v.">xv()</a> as variables. </td></tr>
     <tr><td class="paramname">use_in_transcription</td><td>specifies the components of the problem to which the constraint should be added.</td></tr>
   </table>
   </dd>

doxygen_cxx/classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_edge.html

@@ -381,7 +381,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a34a9db3ba8b38c63a5229888
 <p>Adds a constraint to this vertex. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">bindings</td><td>must contain <em>only</em> elements of <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_vertex.html#ad7acb25ff1d4759a67548a22e11c1a5f" title="Returns a decision variable corresponding to an element of the ConvexSet, which can be used for const...">x()</a> as variables. </td></tr>
+    <tr><td class="paramname">binding</td><td>must contain <em>only</em> elements of <a class="el" href="classdrake_1_1geometry_1_1optimization_1_1_graph_of_convex_sets_1_1_vertex.html#ad7acb25ff1d4759a67548a22e11c1a5f" title="Returns a decision variable corresponding to an element of the ConvexSet, which can be used for const...">x()</a> as variables. </td></tr>
     <tr><td class="paramname">use_in_transcription</td><td>specifies the components of the problem to which the constraint should be added. </td></tr>
   </table>
   </dd>