Skip to content

Commit 0bd407d

Browse files
1 parent 4660d01 commit 0bd407d

File tree

4 files changed

+68
-60
lines changed

4 files changed

+68
-60
lines changed

doxygen_cxx/classdrake_1_1solvers_1_1_function_evaluator-members.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@
177177
<tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html#a02a07120f7c6129f84805da698628514">EvaluatorBase</a>(int num_outputs, int num_vars, const std::string &amp;description=&quot;&quot;)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html">EvaluatorBase</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
178178
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html#a354f93ba1d779ed1c47c4e8324da0572">FunctionEvaluator</a>(const FunctionEvaluator &amp;)=delete</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html">FunctionEvaluator&lt; F &gt;</a></td><td class="entry"></td></tr>
179179
<tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html#acdf5f36661f19fe32153b8a1ad162d16">FunctionEvaluator</a>(FunctionEvaluator &amp;&amp;)=delete</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html">FunctionEvaluator&lt; F &gt;</a></td><td class="entry"></td></tr>
180-
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html#afd4c57b903f824c6b99c43c023cc736b">FunctionEvaluator</a>(FF &amp;&amp;f, Args &amp;&amp;... args)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html">FunctionEvaluator&lt; F &gt;</a></td><td class="entry"></td></tr>
180+
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html#afd4c57b903f824c6b99c43c023cc736b">FunctionEvaluator</a>(FF &amp;&amp;f, Args &amp;&amp;... args)</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html">FunctionEvaluator&lt; F &gt;</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
181181
<tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html#a9d396aa41946b5200c405baa40542d1c">get_description</a>() const</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html">EvaluatorBase</a></td><td class="entry"></td></tr>
182182
<tr class="even"><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html#a187ba29ac182f53fcfe0654e95fcb3af">gradient_sparsity_pattern</a>() const</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html">EvaluatorBase</a></td><td class="entry"></td></tr>
183183
<tr><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html#af0090c5864cf00d7c4ce9cb64d946194">is_thread_safe</a>() const</td><td class="entry"><a class="el" href="classdrake_1_1solvers_1_1_evaluator_base.html">EvaluatorBase</a></td><td class="entry"></td></tr>

doxygen_cxx/classdrake_1_1solvers_1_1_function_evaluator.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#afd4c57b903f824c6b99c43c0
329329

330330
<div class="memitem">
331331
<div class="memproto">
332+
<table class="mlabels">
333+
<tr>
334+
<td class="mlabels-left">
332335
<table class="memname">
333336
<tr>
334337
<td class="memname"><a class="el" href="classdrake_1_1solvers_1_1_function_evaluator.html">FunctionEvaluator</a> </td>
@@ -348,6 +351,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#afd4c57b903f824c6b99c43c0
348351
<td></td><td></td>
349352
</tr>
350353
</table>
354+
</td>
355+
<td class="mlabels-right">
356+
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
357+
</tr>
358+
</table>
351359
</div><div class="memdoc">
352360

353361
<p>Constructs an instance by copying from an lvalue or rvalue of <code>F</code>. </p>

doxygen_cxx/drake__throw_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4d9c29b101212c8a886c7f4f
210210
</tr>
211211
</table>
212212
</div><div class="memdoc">
213-
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div><div class="line"> typedef ::drake::assert::ConditionTraits&lt; \</div><div class="line"> typename std::remove_cv_t&lt;decltype(condition)&gt;&gt; Trait; \</div><div class="line"> static_assert(Trait::is_valid, <span class="stringliteral">&quot;Condition should be bool-convertible.&quot;</span>); \</div><div class="line"> static_assert( \</div><div class="line"> !std::is_pointer_v&lt;decltype(condition)&gt;, \</div><div class="line"> <span class="stringliteral">&quot;When using DRAKE_THROW_UNLESS on a raw pointer, always write out &quot;</span> \</div><div class="line"> <span class="stringliteral">&quot;DRAKE_THROW_UNLESS(foo != nullptr), do not write DRAKE_THROW_UNLESS&quot;</span> \</div><div class="line"> <span class="stringliteral">&quot;(foo) and rely on implicit pointer-to-bool conversion.&quot;</span>); \</div><div class="line"> if (!<a class="code" href="namespacedrake_1_1symbolic.html#a71af97c3ebea42d1b33aa8a41b975d0e">Trait::Evaluate</a>(condition)) { \</div><div class="line"> ::drake::internal::Throw(#condition, __func__, __FILE__, __LINE__); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span> (0)</div><div class="ttc" id="namespacedrake_1_1symbolic_html_a71af97c3ebea42d1b33aa8a41b975d0e"><div class="ttname"><a href="namespacedrake_1_1symbolic.html#a71af97c3ebea42d1b33aa8a41b975d0e">drake::symbolic::Evaluate</a></div><div class="ttdeci">std::enable_if_t&lt; std::is_same_v&lt; typename Derived::Scalar, Expression &gt;, MatrixLikewise&lt; double, Derived &gt; &gt; Evaluate(const Eigen::MatrixBase&lt; Derived &gt; &amp;m, const Environment &amp;env=Environment{}, RandomGenerator *random_generator=nullptr)</div><div class="ttdoc">Evaluates a symbolic matrix m using env and random_generator.</div><div class="ttdef"><b>Definition:</b> expression.h:1589</div></div>
213+
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div><div class="line"> typedef ::drake::assert::ConditionTraits&lt; \</div><div class="line"> typename std::remove_cv_t&lt;decltype(condition)&gt;&gt; Trait; \</div><div class="line"> static_assert(Trait::is_valid, <span class="stringliteral">&quot;Condition should be bool-convertible.&quot;</span>); \</div><div class="line"> static_assert( \</div><div class="line"> !std::is_pointer_v&lt;decltype(condition)&gt;, \</div><div class="line"> <span class="stringliteral">&quot;When using DRAKE_THROW_UNLESS on a raw pointer, always write out &quot;</span> \</div><div class="line"> <span class="stringliteral">&quot;DRAKE_THROW_UNLESS(foo != nullptr), do not write DRAKE_THROW_UNLESS&quot;</span> \</div><div class="line"> <span class="stringliteral">&quot;(foo) and rely on implicit pointer-to-bool conversion.&quot;</span>); \</div><div class="line"> if (!<a class="code" href="namespacedrake_1_1symbolic.html#a71af97c3ebea42d1b33aa8a41b975d0e">Trait::Evaluate</a>(condition)) { \</div><div class="line"> ::drake::internal::Throw(#condition, __func__, __FILE__, __LINE__); \</div><div class="line"> } \</div><div class="line"> } <span class="keywordflow">while</span> (0)</div><div class="ttc" id="namespacedrake_1_1symbolic_html_a71af97c3ebea42d1b33aa8a41b975d0e"><div class="ttname"><a href="namespacedrake_1_1symbolic.html#a71af97c3ebea42d1b33aa8a41b975d0e">drake::symbolic::Evaluate</a></div><div class="ttdeci">std::enable_if_t&lt; std::is_same_v&lt; typename Derived::Scalar, Expression &gt;, MatrixLikewise&lt; double, Derived &gt; &gt; Evaluate(const Eigen::MatrixBase&lt; Derived &gt; &amp;m, const Environment &amp;env=Environment{}, RandomGenerator *random_generator=nullptr)</div><div class="ttdoc">Evaluates a symbolic matrix m using env and random_generator.</div><div class="ttdef"><b>Definition:</b> expression.h:1590</div></div>
214214
</div><!-- fragment -->
215215
<p>Evaluates <code>condition</code> and iff the value is false will throw an exception with a message showing at least the condition text, function name, file, and line. </p>
216216
<p>The condition must not be a pointer, where we'd implicitly rely on its nullness. Instead, always write out "!= nullptr" to be precise.</p>

0 commit comments

Comments
 (0)