Documentation: RobotLocomotion/drake@3d0807d

Author: drake-jenkins-bot

doxygen_cxx/classdrake_1_1planning_1_1_dof_mask-members.html

@@ -177,7 +177,9 @@
   <tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a53d6a890bbb63ccc6103227ac47ad0a9">GetColumnsFromMatrix</a>(const Eigen::Ref&lt; const Eigen::MatrixXd &gt; &amp;full_mat) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#ac14bc418a0258c2c663cdabf41f344a5">GetFromArray</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;full_vec, drake::EigenPtr&lt; Eigen::VectorXd &gt; output) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a7766396b12123290ee5ec8051b231f5d">GetFromArray</a>(const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;full_vec) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a3a892f51cd48008fe2f297a4946a0f45">GetJoints</a>(const multibody::MultibodyPlant&lt; double &gt; &amp;plant) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a4a968b6e61a6112f935a4e5a2166be56">GetFullToSelectedIndex</a>() const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a3a892f51cd48008fe2f297a4946a0f45">GetJoints</a>(const multibody::MultibodyPlant&lt; double &gt; &amp;plant) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a27885b488d600db02c271a5a778c8ca7">GetSelectedToFullIndex</a>() const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#ab7acb98f3ab778b06fbc2924e3dfc5fd">Intersect</a>(const DofMask &amp;other) const</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#aea13ee34fe7d4b0490da1ad17e4f734a">MakeFromModel</a>(const multibody::MultibodyPlant&lt; double &gt; &amp;plant, multibody::ModelInstanceIndex model_index)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a96bbd9f5795e464306420569b8f03a08">MakeFromModel</a>(const multibody::MultibodyPlant&lt; double &gt; &amp;plant, const std::string &amp;model_name)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html">DofMask</a></td><td class="entry"><span class="mlabel">static</span></td></tr>

doxygen_cxx/classdrake_1_1planning_1_1_dof_mask.html

@@ -241,6 +241,12 @@
 <tr class="memitem:a0e166197ba3335fb4bbaa69cc9c81999"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a0e166197ba3335fb4bbaa69cc9c81999">SetInArray</a> (const Eigen::Ref&lt; const Eigen::VectorXd &gt; &amp;vec, <a class="el" href="classdrake_1_1_eigen_ptr.html">drake::EigenPtr</a>&lt; Eigen::VectorXd &gt; output) const</td></tr>
 <tr class="memdesc:a0e166197ba3335fb4bbaa69cc9c81999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the values given in <code>vec</code> into <code>output</code>.  <a href="#a0e166197ba3335fb4bbaa69cc9c81999">More...</a><br /></td></tr>
 <tr class="separator:a0e166197ba3335fb4bbaa69cc9c81999"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a27885b488d600db02c271a5a778c8ca7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classint.html">int</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a27885b488d600db02c271a5a778c8ca7">GetSelectedToFullIndex</a> () const</td></tr>
+<tr class="memdesc:a27885b488d600db02c271a5a778c8ca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">If we have q_selected = dof_mask.GetFromArray(q_full), then this function returns a mapping from q_selected index to q_full index, such that q_selected[i] is the same as q_full[dof_mask.GetSelectedToFullIndex()[i]].  <a href="#a27885b488d600db02c271a5a778c8ca7">More...</a><br /></td></tr>
+<tr class="separator:a27885b488d600db02c271a5a778c8ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4a968b6e61a6112f935a4e5a2166be56"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::optional&lt; <a class="el" href="classint.html">int</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a4a968b6e61a6112f935a4e5a2166be56">GetFullToSelectedIndex</a> () const</td></tr>
+<tr class="memdesc:a4a968b6e61a6112f935a4e5a2166be56"><td class="mdescLeft">&#160;</td><td class="mdescRight">The inverse mapping of <a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a27885b488d600db02c271a5a778c8ca7" title="If we have q_selected = dof_mask.GetFromArray(q_full), then this function returns a mapping from q_se...">GetSelectedToFullIndex()</a>.  <a href="#a4a968b6e61a6112f935a4e5a2166be56">More...</a><br /></td></tr>
+<tr class="separator:a4a968b6e61a6112f935a4e5a2166be56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
@@ -553,6 +559,26 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7766396b12123290ee5ec805
 <p>Overload for <a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#ac14bc418a0258c2c663cdabf41f344a5" title="@group Scattering and gathering">GetFromArray()</a> which returns the read values in a new vector instead of writing to an output argument. </p>
 <dl class="section pre"><dt>Precondition</dt><dd><code>full_vec.size() == <a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#af9593d4a5ff4274efaf429cb4f9e57cc" title="@group Introspection">size()</a></code>. </dd></dl>
 
+</div>
+</div>
+<a id="a4a968b6e61a6112f935a4e5a2166be56"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4a968b6e61a6112f935a4e5a2166be56">&#9670;&nbsp;</a></span>GetFullToSelectedIndex()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::vector&lt;std::optional&lt;<a class="el" href="classint.html">int</a>&gt; &gt; GetFullToSelectedIndex </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The inverse mapping of <a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a27885b488d600db02c271a5a778c8ca7" title="If we have q_selected = dof_mask.GetFromArray(q_full), then this function returns a mapping from q_se...">GetSelectedToFullIndex()</a>. </p>
+<p>If we have q_selected = dof_mask.GetFromArray(q_full), the this function returns the mapping from q_full index to q_selected index. Namely if dof_mask[i] is true, namely q_full[i] is selected, then q_selected[*dof_mask.<a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#a4a968b6e61a6112f935a4e5a2166be56" title="The inverse mapping of GetSelectedToFullIndex().">GetFullToSelectedIndex()</a>[i]] is the same as q_full[i]; if dof_mask[i] is false, then dof_mask.GetFullToSelectedIndex()[i] is nullopt. </p>
+
 </div>
 </div>
 <a id="a3a892f51cd48008fe2f297a4946a0f45"></a>
@@ -576,6 +602,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3a892f51cd48008fe2f297a4
 <dd>
 <code>plant.num_positions() == <a class="el" href="classdrake_1_1planning_1_1_dof_mask.html#af9593d4a5ff4274efaf429cb4f9e57cc" title="@group Introspection">size()</a></code>. </dd></dl>
 
+</div>
+</div>
+<a id="a27885b488d600db02c271a5a778c8ca7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a27885b488d600db02c271a5a778c8ca7">&#9670;&nbsp;</a></span>GetSelectedToFullIndex()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::vector&lt;<a class="el" href="classint.html">int</a>&gt; GetSelectedToFullIndex </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>If we have q_selected = dof_mask.GetFromArray(q_full), then this function returns a mapping from q_selected index to q_full index, such that q_selected[i] is the same as q_full[dof_mask.GetSelectedToFullIndex()[i]]. </p>
+
 </div>
 </div>
 <a id="ab7acb98f3ab778b06fbc2924e3dfc5fd"></a>

doxygen_cxx/classdrake_1_1planning_1_1_dof_mask.js

@@ -12,7 +12,9 @@ var classdrake_1_1planning_1_1_dof_mask =
     [ "GetColumnsFromMatrix", "classdrake_1_1planning_1_1_dof_mask.html#a53d6a890bbb63ccc6103227ac47ad0a9", null ],
     [ "GetFromArray", "classdrake_1_1planning_1_1_dof_mask.html#ac14bc418a0258c2c663cdabf41f344a5", null ],
     [ "GetFromArray", "classdrake_1_1planning_1_1_dof_mask.html#a7766396b12123290ee5ec8051b231f5d", null ],
+    [ "GetFullToSelectedIndex", "classdrake_1_1planning_1_1_dof_mask.html#a4a968b6e61a6112f935a4e5a2166be56", null ],
     [ "GetJoints", "classdrake_1_1planning_1_1_dof_mask.html#a3a892f51cd48008fe2f297a4946a0f45", null ],
+    [ "GetSelectedToFullIndex", "classdrake_1_1planning_1_1_dof_mask.html#a27885b488d600db02c271a5a778c8ca7", null ],
     [ "Intersect", "classdrake_1_1planning_1_1_dof_mask.html#ab7acb98f3ab778b06fbc2924e3dfc5fd", null ],
     [ "MakeFromModel", "classdrake_1_1planning_1_1_dof_mask.html#aea13ee34fe7d4b0490da1ad17e4f734a", null ],
     [ "MakeFromModel", "classdrake_1_1planning_1_1_dof_mask.html#a96bbd9f5795e464306420569b8f03a08", null ],