Documentation: RobotLocomotion/drake@642890a

Author: drake-jenkins-bot

doxygen_cxx/classdrake_1_1multibody_1_1_solver_interface.html

@@ -501,7 +501,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8db04057f790b27227d10ae6
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 </div>
 </div>

doxygen_cxx/classdrake_1_1planning_1_1_iris_np2_options-members.html

@@ -179,6 +179,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html#a3a563c6feff7da2c1e28102c79ee70d2">sampling_strategy</a></td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html">IrisNp2Options</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html#a8e8824802dedfbc36776227f7482b6bc">Serialize</a>(Archive *a)</td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html">IrisNp2Options</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html#a1717b842ef7560038a1ee8f5076d7721">solver</a></td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html">IrisNp2Options</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html#aa705e1cce16e5f276d9f1ff95851698e">solver_options</a></td><td class="entry"><a class="el" href="classdrake_1_1planning_1_1_iris_np2_options.html">IrisNp2Options</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 </div><!-- container -->

doxygen_cxx/classdrake_1_1planning_1_1_iris_np2_options.html

@@ -187,6 +187,8 @@
 Public Attributes</h2></td></tr>
 <tr class="memitem:a1717b842ef7560038a1ee8f5076d7721" id="r_a1717b842ef7560038a1ee8f5076d7721"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html">solvers::SolverInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1717b842ef7560038a1ee8f5076d7721">solver</a> {nullptr}</td></tr>
 <tr class="memdesc:a1717b842ef7560038a1ee8f5076d7721"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user can specify a solver to use for the counterexample search program.  <br /></td></tr>
+<tr class="memitem:aa705e1cce16e5f276d9f1ff95851698e" id="r_aa705e1cce16e5f276d9f1ff95851698e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdrake_1_1solvers_1_1_solver_options.html">solvers::SolverOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa705e1cce16e5f276d9f1ff95851698e">solver_options</a> {}</td></tr>
+<tr class="memdesc:aa705e1cce16e5f276d9f1ff95851698e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options passed to the counterexample search program solver.  <br /></td></tr>
 <tr class="memitem:a6a02069c3e43c0097629cb4a6ea6fbbf" id="r_a6a02069c3e43c0097629cb4a6ea6fbbf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdrake_1_1planning_1_1_common_sampled_iris_options.html">CommonSampledIrisOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6a02069c3e43c0097629cb4a6ea6fbbf">sampled_iris_options</a> {}</td></tr>
 <tr class="memdesc:a6a02069c3e43c0097629cb4a6ea6fbbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options common to IRIS-type algorithms.  <br /></td></tr>
 <tr class="memitem:abc0d5447b03efcbc73d4cfdb20865aa4" id="r_abc0d5447b03efcbc73d4cfdb20865aa4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdrake_1_1planning_1_1_iris_parameterization_function.html">IrisParameterizationFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abc0d5447b03efcbc73d4cfdb20865aa4">parameterization</a> {}</td></tr>
@@ -447,6 +449,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1717b842ef7560038a1ee8f5
 <p>The user can specify a solver to use for the counterexample search program. </p>
 <p>If nullptr (the default value) is given, then <a class="el" href="namespacedrake_1_1solvers.html#af70d41b17760217e0926be91e74c7516" title="Makes the first available and enabled solver.">solvers::MakeFirstAvailableSolver</a> will be used to pick the solver. </p>
 
+</div>
+</div>
+<a id="aa705e1cce16e5f276d9f1ff95851698e" name="aa705e1cce16e5f276d9f1ff95851698e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa705e1cce16e5f276d9f1ff95851698e">&#9670;&#160;</a></span>solver_options</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="structdrake_1_1solvers_1_1_solver_options.html">solvers::SolverOptions</a> solver_options {}</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Options passed to the counterexample search program solver. </p>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>

doxygen_cxx/classdrake_1_1planning_1_1_iris_np2_options.js

@@ -11,5 +11,6 @@ var classdrake_1_1planning_1_1_iris_np2_options =
     [ "ray_sampler_options", "classdrake_1_1planning_1_1_iris_np2_options.html#a2c74243889b1835c087d8160272e007a", null ],
     [ "sampled_iris_options", "classdrake_1_1planning_1_1_iris_np2_options.html#a6a02069c3e43c0097629cb4a6ea6fbbf", null ],
     [ "sampling_strategy", "classdrake_1_1planning_1_1_iris_np2_options.html#a3a563c6feff7da2c1e28102c79ee70d2", null ],
-    [ "solver", "classdrake_1_1planning_1_1_iris_np2_options.html#a1717b842ef7560038a1ee8f5076d7721", null ]
+    [ "solver", "classdrake_1_1planning_1_1_iris_np2_options.html#a1717b842ef7560038a1ee8f5076d7721", null ],
+    [ "solver_options", "classdrake_1_1planning_1_1_iris_np2_options.html#aa705e1cce16e5f276d9f1ff95851698e", null ]
 ];

doxygen_cxx/classdrake_1_1solvers_1_1_clarabel_solver.html

@@ -531,7 +531,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>
 

doxygen_cxx/classdrake_1_1solvers_1_1_clp_solver.html

@@ -531,7 +531,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>
 

doxygen_cxx/classdrake_1_1solvers_1_1_csdp_solver.html

@@ -540,7 +540,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>
 

doxygen_cxx/classdrake_1_1solvers_1_1_equality_constrained_q_p_solver.html

@@ -543,7 +543,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>
 

doxygen_cxx/classdrake_1_1solvers_1_1_gurobi_solver.html

@@ -696,7 +696,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>
 

doxygen_cxx/classdrake_1_1solvers_1_1_ipopt_solver.html

@@ -530,7 +530,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af2ff6a250a78bb79ef64f752
 </div><div class="memdoc">
 
 <p>Solves an optimization program with optional initial guess and solver options. </p>
-<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
+<p>Note that these initial guess and solver options are not written to <code class="param">prog</code>. If the <code class="param">prog</code> has set an initial guess, and <code class="param">initial_guess</code> is set, then <code class="param">initial_guess</code> takes priority. If the <code class="param">prog</code> has set an option for a solver, and <code class="param">solver_options</code> contains a different value for the same option on the same solver, then <code class="param">solver_options</code> takes priority. Derived implementations of this interface may elect to throw std::exception for badly formed programs. </p>
 
 <p>Implements <a class="el" href="classdrake_1_1solvers_1_1_solver_interface.html#aec933bef2f8c7a702a6fd5c59feac5ec">SolverInterface</a>.</p>