Skip to content

Commit 2d209db

Browse files
1 parent 0460c45 commit 2d209db

11 files changed

+39
-39
lines changed

doxygen_cxx/expect__no__throw_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7226e0d109de2f98e1406ddf
217217
</tr>
218218
</table>
219219
</div><div class="memdoc">
220-
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">try</span> { \</div><div class="line"> statement; \</div><div class="line"> } <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::exception&amp; e) { \</div><div class="line"> fail_macro() \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Expected: Does not throw:\n &quot;</span> &lt;&lt; #statement &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Actual: Throws &quot;</span> &lt;&lt; <a class="code" href="classdrake_1_1_nice_type_name.html#a65c4629b9ee5e540e85bfc3298a5445b">::drake::NiceTypeName::Get</a>(e) &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; e.what(); \</div><div class="line"> } <span class="keywordflow">catch</span> (...) { \</div><div class="line"> fail_macro() \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Expected: Does not throw:\n &quot;</span> &lt;&lt; #statement &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Actual: Throws type which does not inherit from std::exception&quot;</span>; \</div><div class="line"> }</div><div class="ttc" id="classdrake_1_1_nice_type_name_html_a65c4629b9ee5e540e85bfc3298a5445b"><div class="ttname"><a href="classdrake_1_1_nice_type_name.html#a65c4629b9ee5e540e85bfc3298a5445b">drake::NiceTypeName::Get</a></div><div class="ttdeci">static std::string Get()</div><div class="ttdoc">Returns a nicely demangled and canonicalized type name that is the same on all platforms,...</div><div class="ttdef"><b>Definition:</b> nice_type_name.h:51</div></div>
220+
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">try</span> { \</div><div class="line"> statement; \</div><div class="line"> } <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::exception&amp; e) { \</div><div class="line"> fail_macro() &lt;&lt; <span class="stringliteral">&quot;Expected: Does not throw:\n &quot;</span> &lt;&lt; #statement &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Actual: Throws &quot;</span> &lt;&lt; <a class="code" href="classdrake_1_1_nice_type_name.html#a65c4629b9ee5e540e85bfc3298a5445b">::drake::NiceTypeName::Get</a>(e) \</div><div class="line"> &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; e.what(); \</div><div class="line"> } <span class="keywordflow">catch</span> (...) { \</div><div class="line"> fail_macro() \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Expected: Does not throw:\n &quot;</span> &lt;&lt; #statement &lt;&lt; std::endl \</div><div class="line"> &lt;&lt; <span class="stringliteral">&quot;Actual: Throws type which does not inherit from std::exception&quot;</span>; \</div><div class="line"> }</div><div class="ttc" id="classdrake_1_1_nice_type_name_html_a65c4629b9ee5e540e85bfc3298a5445b"><div class="ttname"><a href="classdrake_1_1_nice_type_name.html#a65c4629b9ee5e540e85bfc3298a5445b">drake::NiceTypeName::Get</a></div><div class="ttdeci">static std::string Get()</div><div class="ttdoc">Returns a nicely demangled and canonicalized type name that is the same on all platforms,...</div><div class="ttdef"><b>Definition:</b> nice_type_name.h:51</div></div>
221221
</div><!-- fragment -->
222222
</div>
223223
</div>

doxygen_cxx/group__schema__stochastic.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,11 @@
166166
<h1>Stochastic variables</h1>
167167
<p>We'll explain uses of <a class="el" href="classdrake_1_1schema_1_1_distribution.html" title="Base class for a single distribution, to be used with YAML archives.">schema::Distribution</a> and related types using the matching YAML syntax as parsed by <a class="el" href="namespacedrake_1_1yaml.html#a43b0aad3a987a2b97f89a68d934fb982" title="Loads data from a YAML-formatted file.">yaml::LoadYamlFile</a>.</p>
168168
<p>Given this C++ data structure:</p>
169-
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyStuff {</div><div class="line"> <a class="code" href="namespacedrake_1_1schema.html#ab732700b0814fc1fba1b7b8cd80f9e53">schema::DistributionVariant</a> value;</div><div class="line">};</div><div class="line"></div><div class="line">MyStuff stuff;</div></div><!-- fragment --><p>You might load a YAML file such as this:</p>
169+
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyStuff {</div><div class="line"> <a class="code" href="namespacedrake_1_1schema.html#ad3e2ce226a24d035921a3f34a30c42be">schema::DistributionVariant</a> value;</div><div class="line">};</div><div class="line"></div><div class="line">MyStuff stuff;</div></div><!-- fragment --><p>You might load a YAML file such as this:</p>
170170
<div class="fragment"><div class="line">stuff:</div><div class="line"> value: 1.0</div></div><!-- fragment --><p>The <code>stuff.value</code> is set to a constant (not stochastic) value 1.0.</p>
171171
<p>Alternatively, you might load a YAML file such as this:</p>
172172
<div class="fragment"><div class="line">stuff:</div><div class="line"> value: !Gaussian</div><div class="line"> mean: 1.0</div><div class="line"> stddev: 0.5</div></div><!-- fragment --><p>Now, <code>stuff.value</code> is set to gaussian variable with the given mean and standard deviation.</p>
173-
<p>The exclamation point syntax is a YAML type tag, which we use to specify the type choice within an <code>std::variant</code>. The <a class="el" href="namespacedrake_1_1schema.html#ab732700b0814fc1fba1b7b8cd80f9e53" title="Variant over all kinds of distributions.">schema::DistributionVariant</a> is a typedef for a specific <code>std::variant</code>.</p>
173+
<p>The exclamation point syntax is a YAML type tag, which we use to specify the type choice within an <code>std::variant</code>. The <a class="el" href="namespacedrake_1_1schema.html#ad3e2ce226a24d035921a3f34a30c42be" title="Variant over all kinds of distributions.">schema::DistributionVariant</a> is a typedef for a specific <code>std::variant</code>.</p>
174174
<p>There are a few other choices for the type.</p>
175175
<p>Here, you might specify a real-valued uniform range:</p>
176176
<div class="fragment"><div class="line">stuff:</div><div class="line"> value: !Uniform</div><div class="line"> <a class="code" href="namespacedrake_1_1ad.html#a849557ce3b5be163a80c435081991f29">min</a>: 1.0</div><div class="line"> <a class="code" href="namespacedrake_1_1ad.html#afc29155af5cab118516ad1184659e2de">max</a>: 5.0</div></div><!-- fragment --><p>Or, you might choose from a set of equally-likely options:</p>

0 commit comments

Comments
 (0)