Documentation: RobotLocomotion/drake@9a3929f

Author: drake-jenkins-bot

doxygen_cxx/group__analysis.html

@@ -343,13 +343,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6b12640ee9d9dffdef56ecb
 <dl class="section return"><dt>Returns</dt><dd>A discrete-time <a class="el" href="classdrake_1_1systems_1_1_system.html" title="Base class for all System functionality that is dependent on the templatized scalar type T for input,...">System</a>. </dd></dl>
 <dl class="exception"><dt>Exceptions</dt><dd>
   <table class="exception">
-    <tr><td class="paramname">if</td><td>the <code>system</code> is not continuous or <code>time_period</code> &lt;= 0.</td></tr>
+    <tr><td class="paramname">if</td><td>the <code>system</code> is not continuous or <code>time_period</code> &lt;= 0. </td></tr>
+    <tr><td class="paramname">std::exception</td><td>if the integration scheme does not support the scalar type T.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
-    <tr><td class="paramname">T</td><td>The scalar type, which must be one of the <a class="el" href="group__default__scalars.html">default nonsymbolic scalars</a>. </td></tr>
+    <tr><td class="paramname">T</td><td>The scalar type, which must be one of the <a class="el" href="group__default__scalars.html">default scalars</a>. </td></tr>
   </table>
   </dd>
 </dl>
@@ -392,7 +393,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga54865a7137538639aac5b16
 <dl class="section warning"><dt>Warning</dt><dd>The <code>system</code> reference must remain valid for the lifetime of the returned system.</dd></dl>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
-    <tr><td class="paramname">T</td><td>The scalar type, which must be one of the <a class="el" href="group__default__scalars.html">default nonsymbolic scalars</a>. </td></tr>
+    <tr><td class="paramname">T</td><td>The scalar type, which must be one of the <a class="el" href="group__default__scalars.html">default scalars</a>. </td></tr>
   </table>
   </dd>
 </dl>

doxygen_cxx/group__simulator__configuration.html

@@ -188,6 +188,10 @@
 <tr class="memitem:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="memTemplItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classdrake_1_1systems_1_1_integrator_base.html">IntegratorBase</a>&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simulator__configuration.html#gaaf4e6ced63bc542a51f1ee61d864480f">CreateIntegratorFromConfig</a> (const <a class="el" href="classdrake_1_1systems_1_1_system.html">System</a>&lt; T &gt; *system, const <a class="el" href="structdrake_1_1systems_1_1_simulator_config.html">SimulatorConfig</a> &amp;integrator_config)</td></tr>
 <tr class="memdesc:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an integrator according to the given configuration.  <a href="group__simulator__configuration.html#gaaf4e6ced63bc542a51f1ee61d864480f">More...</a><br /></td></tr>
 <tr class="separator:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
+<tr class="memitem:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">IsScalarTypeSupportedByIntegrator</a> (std::string_view integration_scheme)</td></tr>
+<tr class="memdesc:ga1de5476f115ca0e4e00424c001f63ef7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports if an integration scheme supports the scalar type T.  <a href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">More...</a><br /></td></tr>
+<tr class="separator:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function Documentation</h2>
 <a id="ga6875fa2f1e9eb22cee800a29b0ca61b9"></a>
@@ -334,6 +338,44 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5d1fc9d510c450590826170
 
 <p>Returns the allowed string values for the <code>scheme</code> parameter in <a class="el" href="group__simulator__configuration.html#gad32461bc90073aac39049d636974a04b" title="Resets the integrator used to advanced the continuous time dynamics of the system associated with sim...">ResetIntegratorFromFlags()</a> and <a class="el" href="structdrake_1_1systems_1_1_simulator_config.html#a6d19fbfb5574d3ff27ca14c74141824f">SimulatorConfig::integration_scheme</a>. </p>
 
+</div>
+</div>
+<a id="ga1de5476f115ca0e4e00424c001f63ef7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga1de5476f115ca0e4e00424c001f63ef7">&#9670;&nbsp;</a></span>IsScalarTypeSupportedByIntegrator()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool drake::systems::IsScalarTypeSupportedByIntegrator </td>
+          <td>(</td>
+          <td class="paramtype">std::string_view&#160;</td>
+          <td class="paramname"><em>integration_scheme</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Reports if an integration scheme supports the scalar type T. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">integration_scheme</td><td>Integration scheme to be checked. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="exception"><dt>Exceptions</dt><dd>
+  <table class="exception">
+    <tr><td class="paramname">std::exception</td><td>if the integration scheme does not match any of <a class="el" href="group__simulator__configuration.html#ga5d1fc9d510c450590826170fca172e5a" title="Returns the allowed string values for the scheme parameter in ResetIntegratorFromFlags() and Simulato...">GetIntegrationSchemes()</a>. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="tparams"><dt>Template Parameters</dt><dd>
+  <table class="tparams">
+    <tr><td class="paramname">T</td><td>The scalar type, which must be one of the <a class="el" href="group__default__scalars.html">default scalars</a>. </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="gad32461bc90073aac39049d636974a04b"></a>

doxygen_cxx/group__simulator__configuration.js

@@ -4,5 +4,6 @@ var group__simulator__configuration =
     [ "CreateIntegratorFromConfig", "group__simulator__configuration.html#gaaf4e6ced63bc542a51f1ee61d864480f", null ],
     [ "ExtractSimulatorConfig", "group__simulator__configuration.html#ga00b67f54aba155c982e8a1038278eed6", null ],
     [ "GetIntegrationSchemes", "group__simulator__configuration.html#ga5d1fc9d510c450590826170fca172e5a", null ],
+    [ "IsScalarTypeSupportedByIntegrator", "group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7", null ],
     [ "ResetIntegratorFromFlags", "group__simulator__configuration.html#gad32461bc90073aac39049d636974a04b", null ]
 ];

doxygen_cxx/namespacedrake_1_1systems.html

@@ -757,6 +757,10 @@
 <tr class="memitem:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="memTemplItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classdrake_1_1systems_1_1_integrator_base.html">IntegratorBase</a>&lt; T &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simulator__configuration.html#gaaf4e6ced63bc542a51f1ee61d864480f">CreateIntegratorFromConfig</a> (const <a class="el" href="classdrake_1_1systems_1_1_system.html">System</a>&lt; T &gt; *system, const <a class="el" href="structdrake_1_1systems_1_1_simulator_config.html">SimulatorConfig</a> &amp;integrator_config)</td></tr>
 <tr class="memdesc:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an integrator according to the given configuration.  <a href="group__simulator__configuration.html#gaaf4e6ced63bc542a51f1ee61d864480f">More...</a><br /></td></tr>
 <tr class="separator:gaaf4e6ced63bc542a51f1ee61d864480f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
+<tr class="memitem:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">IsScalarTypeSupportedByIntegrator</a> (std::string_view integration_scheme)</td></tr>
+<tr class="memdesc:ga1de5476f115ca0e4e00424c001f63ef7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports if an integration scheme supports the scalar type T.  <a href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">More...</a><br /></td></tr>
+<tr class="separator:ga1de5476f115ca0e4e00424c001f63ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a14e4e6cd73fdedd3dde63af60b3572e4"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
 <tr class="memitem:a14e4e6cd73fdedd3dde63af60b3572e4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacedrake_1_1systems.html#a14e4e6cd73fdedd3dde63af60b3572e4">PrintSimulatorStatistics</a> (const <a class="el" href="classdrake_1_1systems_1_1_simulator.html">Simulator</a>&lt; T &gt; &amp;simulator)</td></tr>
 <tr class="memdesc:a14e4e6cd73fdedd3dde63af60b3572e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method outputs to stdout relevant simulation statistics for a simulator that advanced the state of a system forward in time.  <a href="#a14e4e6cd73fdedd3dde63af60b3572e4">More...</a><br /></td></tr>

doxygen_cxx/namespacemembers_func_i.html

@@ -325,22 +325,22 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 : <a class="el" href="namespacedrake_1_1symbolic.html#aac0abfc50fd5ff7cda1e5709688b4569">drake::symbolic</a>
 </li>
 <li>is_sin()
-: <a class="el" href="namespacedrake_1_1symbolic.html#a790f1dea22ffa64d7c75849403aae060">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#a23b9105cdfbe657bfe90eaf47d9e8f11">drake::symbolic</a>
 </li>
 <li>is_sinh()
-: <a class="el" href="namespacedrake_1_1symbolic.html#a0373300d4207624b99351d0f7c347b85">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#aa66cbc3a6c390d0d04bf3839e4377850">drake::symbolic</a>
 </li>
 <li>is_sqrt()
-: <a class="el" href="namespacedrake_1_1symbolic.html#acfe3f1787c60c08adf6af1e1f29ff6cf">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#a6a645e5342fb66cd3fc7de8c38eac6b4">drake::symbolic</a>
 </li>
 <li>is_symbolic_convertible()
-: <a class="el" href="namespacedrake_1_1systems.html#ab7eb9f17930349a33024bcbce629e491">drake::systems</a>
+: <a class="el" href="namespacedrake_1_1systems.html#a19e6b9a3faf658a8c05271bcb6d800ea">drake::systems</a>
 </li>
 <li>is_tan()
-: <a class="el" href="namespacedrake_1_1symbolic.html#a8dd352ee762ef421653cd8941fa5ce22">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#a7eaf3f36c1f3fdf51121f77083894794">drake::symbolic</a>
 </li>
 <li>is_tanh()
-: <a class="el" href="namespacedrake_1_1symbolic.html#a9da61282d0c5ccefeaa2068d84a19273">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#ac06c87629b60cbdc34b8e2a9f715cd41">drake::symbolic</a>
 </li>
 <li>is_true()
 : <a class="el" href="namespacedrake_1_1symbolic.html#a1a71b252df5a615ff80f712e2983ab53">drake::symbolic</a>
@@ -355,7 +355,7 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 : <a class="el" href="namespacedrake_1_1symbolic.html#ab6c97ad4e8b82b5c045695eb76fc1256">drake::symbolic</a>
 </li>
 <li>is_variable()
-: <a class="el" href="namespacedrake_1_1symbolic.html#a184038d04f0ab628e12fb53a6f7cb5d9">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#a571adc7bcdc056eec761a657f9354cd7">drake::symbolic</a>
 </li>
 <li>is_zero()
 : <a class="el" href="namespacedrake_1_1symbolic.html#a717f1ae4a1d038bc7870416276167f19">drake::symbolic</a>
@@ -405,11 +405,14 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 <li>IsQuaternionValid()
 : <a class="el" href="namespacedrake_1_1math.html#a3a0adc68819c94157139c9d6c2e9bca6">drake::math</a>
 </li>
+<li>IsScalarTypeSupportedByIntegrator()
+: <a class="el" href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">drake::systems</a>
+</li>
 <li>IsStabilizable()
 : <a class="el" href="group__control__systems.html#gae9c9e47b54eef5d69f3575c9054547af">drake::systems</a>
 </li>
 <li>IsSymmetric()
-: <a class="el" href="namespacedrake_1_1math.html#a84760cbea23b50efdbe9a85f3967f098">drake::math</a>
+: <a class="el" href="namespacedrake_1_1math.html#a141ec70804c105e09ab3b0a855152b8b">drake::math</a>
 </li>
 </ul>
 </div><!-- contents -->

doxygen_cxx/namespacemembers_i.html

@@ -394,7 +394,7 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 : <a class="el" href="namespacedrake_1_1symbolic.html#acfe3f1787c60c08adf6af1e1f29ff6cf">drake::symbolic</a>
 </li>
 <li>is_symbolic_convertible()
-: <a class="el" href="namespacedrake_1_1systems.html#a19e6b9a3faf658a8c05271bcb6d800ea">drake::systems</a>
+: <a class="el" href="namespacedrake_1_1systems.html#ab7eb9f17930349a33024bcbce629e491">drake::systems</a>
 </li>
 <li>is_tan()
 : <a class="el" href="namespacedrake_1_1symbolic.html#a7eaf3f36c1f3fdf51121f77083894794">drake::symbolic</a>
@@ -415,7 +415,7 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 : <a class="el" href="namespacedrake_1_1symbolic.html#aa47a95b03c275d9687461839c5612472">drake::symbolic</a>
 </li>
 <li>is_variable()
-: <a class="el" href="namespacedrake_1_1symbolic.html#ac014e89da18637b81f9c1fbe6306e689">drake::symbolic</a>
+: <a class="el" href="namespacedrake_1_1symbolic.html#a184038d04f0ab628e12fb53a6f7cb5d9">drake::symbolic</a>
 </li>
 <li>is_zero()
 : <a class="el" href="namespacedrake_1_1symbolic.html#a717f1ae4a1d038bc7870416276167f19">drake::symbolic</a>
@@ -468,6 +468,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 <li>IsQuaternionValid()
 : <a class="el" href="namespacedrake_1_1math.html#a3a0adc68819c94157139c9d6c2e9bca6">drake::math</a>
 </li>
+<li>IsScalarTypeSupportedByIntegrator()
+: <a class="el" href="group__simulator__configuration.html#ga1de5476f115ca0e4e00424c001f63ef7">drake::systems</a>
+</li>
 <li>IsStabilizable()
 : <a class="el" href="group__control__systems.html#gae9c9e47b54eef5d69f3575c9054547af">drake::systems</a>
 </li>

doxygen_cxx/navtreedata.js

@@ -122,20 +122,20 @@ var NAVTREEINDEX =
 "formula_8h.html#aafc2f3979d06df08b80d2b280b9728c7",
 "generic__polynomial_8h.html#afc778273d730c518678796b632e4de8f",
 "group__render__engine__gltf__client__server__api.html",
-"jaco__constants_8h.html#a688a61fff7d08168bac255b9573991c1",
-"minimum__degree__ordering_8h.html",
-"namespacedrake_1_1multibody_1_1test.html",
-"point__cloud__flags_8h.html#a56d63c5b36bdd2d17582653cbc3a626c",
-"reset__on__copy_8h.html",
-"soft__min__max_8h.html#ad5dcb8264087a5079e8103b7241ce77d",
-"structdrake_1_1assert_1_1_condition_traits_3_01symbolic_1_1_formula_01_4.html",
-"structdrake_1_1geometry_1_1_penetration_as_point_pair.html#a8fb4865476844d3b6243bed405bf44a9",
-"structdrake_1_1geometry_1_1optimization_1_1_separation_certificate_program_base.html#a1155fe07f46b586ad6bf51b9b2f8a496",
-"structdrake_1_1multibody_1_1parsing_1_1_add_model.html#a4e550ebb9a213be8a3939f0c6ad4816b",
-"structdrake_1_1solvers_1_1_solver_options.html#ac2adda584ed29a23b6e0bced598f22c3",
-"structdrake_1_1systems_1_1sensors_1_1_image_traits_3_01_pixel_type_1_1k_depth16_u_01_4.html#af38c722527b26de4a7e90ea5d6b21915",
-"symbolic__test__util_8h.html#abca93568505710bf72e917c5c73d4b9c",
-"yaml__read__archive_8h.html"
+"jaco__constants_8h.html#a04639133526c7c4d44d721a97e31587c",
+"min__clique__cover__solver__via__greedy_8h.html",
+"namespacedrake_1_1multibody_1_1parsing.html",
+"point__cloud__flags_8h.html#a2b85005afefc35fb842f7ad4ed1b0b20",
+"reset__after__move_8h.html",
+"soft__min__max_8h.html#a01c6c47a926e29b798e1901f0b4a1913",
+"structdrake_1_1_sorted_pair.html#ace5b7f162bab05d193bcdd27ddee7b3b",
+"structdrake_1_1geometry_1_1_penetration_as_point_pair.html#a403021311aaf56bf9bec819dbbc08932",
+"structdrake_1_1geometry_1_1optimization_1_1_sampled_volume.html#a8eb3ef4958b442309868039dbab6f0bf",
+"structdrake_1_1multibody_1_1parsing_1_1_add_frame.html#ac532c4b500b1a85ea22217f2c65a70ed",
+"structdrake_1_1solvers_1_1_solver_options.html#aac20432da1daa9805e9448e151f2b552",
+"structdrake_1_1systems_1_1sensors_1_1_image_traits_3_01_pixel_type_1_1k_depth16_u_01_4.html#a770fd0c30a2b985c180ebffb9747a07a",
+"symbolic__test__util_8h.html#aad1326f608fbd88ee7647d116ae23e97",
+"yaml__io__options_8h.html"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronisation';

doxygen_cxx/navtreeindex12.js

@@ -55,8 +55,8 @@ var NAVTREEINDEX12 =
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#aacf099e93ba14fd155d19485dfbaad81":[1,5,5,13,3],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ab329d54101a6da1d831312618012bf8f":[1,1,1,13,6],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ab329d54101a6da1d831312618012bf8f":[1,5,5,13,6],
-"classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ac52e0c9482a129ef814ff2ab5e9b1607":[1,1,1,13,0],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ac52e0c9482a129ef814ff2ab5e9b1607":[1,5,5,13,0],
+"classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ac52e0c9482a129ef814ff2ab5e9b1607":[1,1,1,13,0],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#acf3359a9ffe54d19027766e2e2520218":[1,1,1,13,5],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#acf3359a9ffe54d19027766e2e2520218":[1,5,5,13,5],
 "classdrake_1_1geometry_1_1optimization_1_1_minkowski_sum.html#ada1d96f68ad61431e19ea0cb65117cd6":[1,1,1,13,1],

doxygen_cxx/navtreeindex54.js

@@ -96,17 +96,17 @@ var NAVTREEINDEX54 =
 "free__body_8h.html":[4,0,0,8,0,1,0],
 "function_8h.html":[4,0,0,11,20],
 "function__handle__trajectory_8h.html":[4,0,0,1,5,6],
-"functions.html":[3,3,0,0],
 "functions.html":[3,3,0],
+"functions.html":[3,3,0,0],
 "functions_b.html":[3,3,0,1],
 "functions_c.html":[3,3,0,2],
 "functions_d.html":[3,3,0,3],
 "functions_e.html":[3,3,0,4],
 "functions_enum.html":[3,3,4],
 "functions_eval.html":[3,3,5],
 "functions_f.html":[3,3,0,5],
-"functions_func.html":[3,3,1,0],
 "functions_func.html":[3,3,1],
+"functions_func.html":[3,3,1,0],
 "functions_func_b.html":[3,3,1,1],
 "functions_func_c.html":[3,3,1,2],
 "functions_func_d.html":[3,3,1,3],
@@ -145,8 +145,8 @@ var NAVTREEINDEX54 =
 "functions_p.html":[3,3,0,15],
 "functions_q.html":[3,3,0,16],
 "functions_r.html":[3,3,0,17],
-"functions_rela.html":[3,3,6,0],
 "functions_rela.html":[3,3,6],
+"functions_rela.html":[3,3,6,0],
 "functions_rela_b.html":[3,3,6,1],
 "functions_rela_c.html":[3,3,6,2],
 "functions_rela_d.html":[3,3,6,3],