Documentation: RobotLocomotion/drake@9e6a49e

Author: drake-jenkins-bot

doxygen_cxx/classdrake_1_1solvers_1_1_solver_options-members.html

@@ -182,9 +182,7 @@
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a7b3272ee1cbca61b23a0ee9c93069731">operator=</a>(SolverOptions &amp;&amp;)=default</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a75ae4b0e55acd123d4dd077a31e8b0ff">operator==</a>(const SolverOptions &amp;other) const</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a00057ee2a6cf17318bf940681f2aeb20">OptionValue</a> typedef</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a64f5a75df2c33b77454e88fae4d08047">SetOption</a>(const SolverId &amp;solver_id, const std::string &amp;solver_option, double option_value)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#ac1ab5717db6c3382362d3622a187cfaa">SetOption</a>(const SolverId &amp;solver_id, const std::string &amp;solver_option, int option_value)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a258cce4598dc127dfe730f366371a8f4">SetOption</a>(const SolverId &amp;solver_id, const std::string &amp;solver_option, const std::string &amp;option_value)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#af4c4c08922e737f18d2f1960f4f93e02">SetOption</a>(const SolverId &amp;solver_id, std::string key, OptionValue value)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#ac54f45d8221218d66a7f603bee90d21f">SetOption</a>(CommonSolverOption key, OptionValue value)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a6ed5b563dbc1aeae6e6396cf04dc3d63">SolverOptions</a>()=default</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#ac5d150aa10bfd49088ecc4bc42a5e77b">SolverOptions</a>(const SolverOptions &amp;)=default</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html">SolverOptions</a></td><td class="entry"></td></tr>

doxygen_cxx/classdrake_1_1solvers_1_1_solver_options.html

@@ -192,15 +192,9 @@
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a6ed5b563dbc1aeae6e6396cf04dc3d63"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a6ed5b563dbc1aeae6e6396cf04dc3d63">SolverOptions</a> ()=default</td></tr>
 <tr class="separator:a6ed5b563dbc1aeae6e6396cf04dc3d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a64f5a75df2c33b77454e88fae4d08047"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a64f5a75df2c33b77454e88fae4d08047">SetOption</a> (const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;solver_id, const std::string &amp;solver_option, <a class="el" href="classdouble.html">double</a> option_value)</td></tr>
-<tr class="memdesc:a64f5a75df2c33b77454e88fae4d08047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a double-valued solver option for a specific solver.  <a href="#a64f5a75df2c33b77454e88fae4d08047">More...</a><br /></td></tr>
-<tr class="separator:a64f5a75df2c33b77454e88fae4d08047"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac1ab5717db6c3382362d3622a187cfaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#ac1ab5717db6c3382362d3622a187cfaa">SetOption</a> (const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;solver_id, const std::string &amp;solver_option, <a class="el" href="classint.html">int</a> option_value)</td></tr>
-<tr class="memdesc:ac1ab5717db6c3382362d3622a187cfaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets an integer-valued solver option for a specific solver.  <a href="#ac1ab5717db6c3382362d3622a187cfaa">More...</a><br /></td></tr>
-<tr class="separator:ac1ab5717db6c3382362d3622a187cfaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a258cce4598dc127dfe730f366371a8f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a258cce4598dc127dfe730f366371a8f4">SetOption</a> (const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;solver_id, const std::string &amp;solver_option, const std::string &amp;option_value)</td></tr>
-<tr class="memdesc:a258cce4598dc127dfe730f366371a8f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a string-valued solver option for a specific solver.  <a href="#a258cce4598dc127dfe730f366371a8f4">More...</a><br /></td></tr>
-<tr class="separator:a258cce4598dc127dfe730f366371a8f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af4c4c08922e737f18d2f1960f4f93e02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#af4c4c08922e737f18d2f1960f4f93e02">SetOption</a> (const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;solver_id, std::string key, <a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a00057ee2a6cf17318bf940681f2aeb20">OptionValue</a> value)</td></tr>
+<tr class="memdesc:af4c4c08922e737f18d2f1960f4f93e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a solver option for a specific solver.  <a href="#af4c4c08922e737f18d2f1960f4f93e02">More...</a><br /></td></tr>
+<tr class="separator:af4c4c08922e737f18d2f1960f4f93e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac54f45d8221218d66a7f603bee90d21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#ac54f45d8221218d66a7f603bee90d21f">SetOption</a> (<a class="el" href="namespacedrake_1_1solvers.html#ae07229124cd16e9d8b62fe359c7d0b40">CommonSolverOption</a> key, <a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a00057ee2a6cf17318bf940681f2aeb20">OptionValue</a> value)</td></tr>
 <tr class="memdesc:ac54f45d8221218d66a7f603bee90d21f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a common option for all solvers supporting that option (for example, printing the progress in each iteration).  <a href="#ac54f45d8221218d66a7f603bee90d21f">More...</a><br /></td></tr>
 <tr class="separator:ac54f45d8221218d66a7f603bee90d21f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -708,8 +702,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a75ae4b0e55acd123d4dd077a
 
 </div>
 </div>
-<a id="a64f5a75df2c33b77454e88fae4d08047"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a64f5a75df2c33b77454e88fae4d08047">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[1/4]</span></h2>
+<a id="af4c4c08922e737f18d2f1960f4f93e02"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af4c4c08922e737f18d2f1960f4f93e02">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[1/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -723,86 +717,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a64f5a75df2c33b77454e88fa
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
-          <td class="paramname"><em>solver_option</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
-          <td class="paramname"><em>option_value</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Sets a double-valued solver option for a specific solver. </p>
-
-</div>
-</div>
-<a id="ac1ab5717db6c3382362d3622a187cfaa"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ac1ab5717db6c3382362d3622a187cfaa">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[2/4]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void SetOption </td>
-          <td>(</td>
-          <td class="paramtype">const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;&#160;</td>
-          <td class="paramname"><em>solver_id</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
-          <td class="paramname"><em>solver_option</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="classint.html">int</a>&#160;</td>
-          <td class="paramname"><em>option_value</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Sets an integer-valued solver option for a specific solver. </p>
-
-</div>
-</div>
-<a id="a258cce4598dc127dfe730f366371a8f4"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a258cce4598dc127dfe730f366371a8f4">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[3/4]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void SetOption </td>
-          <td>(</td>
-          <td class="paramtype">const <a class="el" href="classdrake_1_1solvers_1_1_solver_id.html">SolverId</a> &amp;&#160;</td>
-          <td class="paramname"><em>solver_id</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
-          <td class="paramname"><em>solver_option</em>, </td>
+          <td class="paramtype">std::string&#160;</td>
+          <td class="paramname"><em>key</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
-          <td class="paramname"><em>option_value</em>&#160;</td>
+          <td class="paramtype"><a class="el" href="classdrake_1_1solvers_1_1_solver_options.html#a00057ee2a6cf17318bf940681f2aeb20">OptionValue</a>&#160;</td>
+          <td class="paramname"><em>value</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -812,12 +734,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a258cce4598dc127dfe730f36
       </table>
 </div><div class="memdoc">
 
-<p>Sets a string-valued solver option for a specific solver. </p>
+<p>Sets a solver option for a specific solver. </p>
+<p>If the solver doesn't support the option, it will throw an exception during the Solve (not when setting the option here). </p>
 
 </div>
 </div>
 <a id="ac54f45d8221218d66a7f603bee90d21f"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ac54f45d8221218d66a7f603bee90d21f">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[4/4]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#ac54f45d8221218d66a7f603bee90d21f">&#9670;&nbsp;</a></span>SetOption() <span class="overload">[2/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">

doxygen_cxx/classdrake_1_1solvers_1_1_solver_options.js

@@ -20,8 +20,6 @@ var classdrake_1_1solvers_1_1_solver_options =
     [ "operator=", "classdrake_1_1solvers_1_1_solver_options.html#a5310559e23a1d9e46c371bc5c9451020", null ],
     [ "operator=", "classdrake_1_1solvers_1_1_solver_options.html#a7b3272ee1cbca61b23a0ee9c93069731", null ],
     [ "operator==", "classdrake_1_1solvers_1_1_solver_options.html#a75ae4b0e55acd123d4dd077a31e8b0ff", null ],
-    [ "SetOption", "classdrake_1_1solvers_1_1_solver_options.html#a64f5a75df2c33b77454e88fae4d08047", null ],
-    [ "SetOption", "classdrake_1_1solvers_1_1_solver_options.html#ac1ab5717db6c3382362d3622a187cfaa", null ],
-    [ "SetOption", "classdrake_1_1solvers_1_1_solver_options.html#a258cce4598dc127dfe730f366371a8f4", null ],
+    [ "SetOption", "classdrake_1_1solvers_1_1_solver_options.html#af4c4c08922e737f18d2f1960f4f93e02", null ],
     [ "SetOption", "classdrake_1_1solvers_1_1_solver_options.html#ac54f45d8221218d66a7f603bee90d21f", null ]
 ];