Documentation: RobotLocomotion/drake@5282e8a

Author: drake-jenkins-bot

doxygen_cxx/classdrake_1_1solvers_1_1_osqp_solver.html

@@ -170,8 +170,9 @@
 <div class="textblock"><p>A wrapper to call <a href="https://osqp.org/">OSQP</a> using Drake's <a class="el" href="classdrake_1_1solvers_1_1_mathematical_program.html" title="MathematicalProgram stores the decision variables, the constraints and costs of an optimization probl...">MathematicalProgram</a>. </p>
 <p>For details about OSQP's available options, refer to the <a href="https://osqp.org/docs/interfaces/solver_settings.html">OSQP manual</a>. Drake uses OSQP's default values for all options except following:</p><ul>
 <li>Drake defaults to <code>polish=true</code> (upstream default is <code>false</code>).</li>
-<li>Drake defaults to <code>adaptive_rho_interval=ADAPTIVE_RHO_FIXED</code> to make the output deterministic (upstream default is <code>0</code>, which uses non-deterministic timing measurements to establish the interval). N.B. Generally the interval should be an integer multiple of <code>check_termination</code>, so if you choose to override either option you should probably override both at once. </li>
+<li>Drake defaults to <code>adaptive_rho_interval=ADAPTIVE_RHO_FIXED</code> to make the output deterministic (upstream default is <code>0</code>, which uses non-deterministic timing measurements to establish the interval). N.B. Generally the interval should be an integer multiple of <code>check_termination</code>, so if you choose to override either option you should probably override both at once.</li>
 </ul>
+<p>At the end of <a class="el" href="classdrake_1_1solvers_1_1_solver_base.html#a00b55f8b4c1c4f19b45621a84deed66c" title="Like SolverInterface::Solve(), but the result is a return value instead of an output argument.">OsqpSolver::Solve()</a> function, we always return the value of the primal and dual variables inside the OSQP solver, regardless of the solver status (whether it is optimal, infeasible, unbounded, etc), except when the problem has an invalid input. Users should always check the solver status before interpreting the returned primal and dual variables. </p>
 </div>
 <p><code>#include &lt;drake/solvers/osqp_solver.h&gt;</code></p>
 <table class="memberdecls">

pydrake/pydrake.solvers.html

@@ -7239,6 +7239,12 @@
 Generally the interval should be an integer multiple of
 <code class="docutils literal notranslate"><span class="pre">check_termination</span></code>, so if you choose to override either option you
 should probably override both at once.</p>
+<p>At the end of OsqpSolver::Solve() function, we always return the value
+of the primal and dual variables inside the OSQP solver, regardless of
+the solver status (whether it is optimal, infeasible, unbounded, etc),
+except when the problem has an invalid input. Users should always
+check the solver status before interpreting the returned primal and
+dual variables.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="pydrake.solvers.OsqpSolver.__init__">
 <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydrake.solvers.OsqpSolver" title="pydrake.solvers.OsqpSolver"><span class="pre">pydrake.solvers.OsqpSolver</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydrake.solvers.OsqpSolver.__init__" title="Permalink to this definition"></a></dt>