Skip to content

Commit

Permalink
Update history and regenerate docs.
Browse files Browse the repository at this point in the history
Also fix some missing documentation links.
[CI SKIP]
  • Loading branch information
jzmaddock committed Mar 8, 2022
1 parent d799692 commit b558996
Show file tree
Hide file tree
Showing 32 changed files with 476 additions and 130 deletions.
2 changes: 1 addition & 1 deletion doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: November 05, 2021 at 19:17:01 GMT</small></p></td>
<td align="left"><p><small>Last revised: March 08, 2022 at 15:51:18 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Expand Down
78 changes: 77 additions & 1 deletion doc/html/indexes/s01.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/html/indexes/s02.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2079495"></a>Class Index</h2></div></div></div>
<a name="id2098029"></a>Class Index</h2></div></div></div>
<p><a class="link" href="s02.html#idx_id_36">A</a> <a class="link" href="s02.html#idx_id_37">B</a> <a class="link" href="s02.html#idx_id_38">C</a> <a class="link" href="s02.html#idx_id_39">D</a> <a class="link" href="s02.html#idx_id_40">E</a> <a class="link" href="s02.html#idx_id_41">F</a> <a class="link" href="s02.html#idx_id_42">G</a> <a class="link" href="s02.html#idx_id_43">H</a> <a class="link" href="s02.html#idx_id_44">I</a> <a class="link" href="s02.html#idx_id_46">K</a> <a class="link" href="s02.html#idx_id_47">L</a> <a class="link" href="s02.html#idx_id_48">M</a> <a class="link" href="s02.html#idx_id_49">N</a> <a class="link" href="s02.html#idx_id_50">O</a> <a class="link" href="s02.html#idx_id_51">P</a> <a class="link" href="s02.html#idx_id_52">Q</a> <a class="link" href="s02.html#idx_id_53">R</a> <a class="link" href="s02.html#idx_id_54">S</a> <a class="link" href="s02.html#idx_id_55">T</a> <a class="link" href="s02.html#idx_id_56">U</a> <a class="link" href="s02.html#idx_id_57">V</a> <a class="link" href="s02.html#idx_id_58">W</a></p>
<div class="variablelist"><dl class="variablelist">
<dt>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/indexes/s03.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2081539"></a>Typedef Index</h2></div></div></div>
<a name="id2103047"></a>Typedef Index</h2></div></div></div>
<p><a class="link" href="s03.html#idx_id_67">A</a> <a class="link" href="s03.html#idx_id_68">B</a> <a class="link" href="s03.html#idx_id_69">C</a> <a class="link" href="s03.html#idx_id_70">D</a> <a class="link" href="s03.html#idx_id_71">E</a> <a class="link" href="s03.html#idx_id_72">F</a> <a class="link" href="s03.html#idx_id_73">G</a> <a class="link" href="s03.html#idx_id_74">H</a> <a class="link" href="s03.html#idx_id_75">I</a> <a class="link" href="s03.html#idx_id_77">K</a> <a class="link" href="s03.html#idx_id_78">L</a> <a class="link" href="s03.html#idx_id_80">N</a> <a class="link" href="s03.html#idx_id_82">P</a> <a class="link" href="s03.html#idx_id_84">R</a> <a class="link" href="s03.html#idx_id_85">S</a> <a class="link" href="s03.html#idx_id_86">T</a> <a class="link" href="s03.html#idx_id_87">U</a> <a class="link" href="s03.html#idx_id_88">V</a> <a class="link" href="s03.html#idx_id_89">W</a></p>
<div class="variablelist"><dl class="variablelist">
<dt>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/indexes/s04.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id2085282"></a>Macro Index</h2></div></div></div>
<a name="id2104969"></a>Macro Index</h2></div></div></div>
<p><a class="link" href="s04.html#idx_id_99">B</a> <a class="link" href="s04.html#idx_id_103">F</a></p>
<div class="variablelist"><dl class="variablelist">
<dt>
Expand Down
123 changes: 122 additions & 1 deletion doc/html/indexes/s05.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions doc/html/internals.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
Testing</a></span></dt>
<dt><span class="section"><a href="math_toolkit/internals/test_data.html">Graphing, Profiling,
and Generating Test Data for Special Functions</a></span></dt>
<dt><span class="section"><a href="math_toolkit/internals/color_maps.html">Color Maps</a></span></dt>
</dl></dd>
</dl>
</div>
Expand Down
39 changes: 39 additions & 0 deletions doc/html/math_toolkit/ccmath.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,45 @@ <h4>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Promoted</span> <span class="identifier">copysign</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">mag</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">sgn</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Real</span> <span class="identifier">hypot</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Promoted</span> <span class="identifier">hypot</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Real</span> <span class="identifier">fdim</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Promoted</span> <span class="identifier">fdim</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Real</span> <span class="identifier">fmax</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Promoted</span> <span class="identifier">fmax</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Real</span> <span class="identifier">fmin</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="identifier">Promoted</span> <span class="identifier">fmin</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span> <span class="special">=</span> <span class="identifier">Arithmetic1</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">isgreater</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span> <span class="special">=</span> <span class="identifier">Arithmetic1</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">isgreaterequal</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span> <span class="special">=</span> <span class="identifier">Arithmetic1</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">isless</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Arithmetic1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arithmetic2</span> <span class="special">=</span> <span class="identifier">Arithmetic1</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">islessequal</span><span class="special">(</span><span class="identifier">Arithmetic1</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">Arithmetic2</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">isunordered</span><span class="special">(</span><span class="identifier">T</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">y</span><span class="special">)</span> <span class="keyword">noexcept</span>

<span class="special">}</span> <span class="comment">// Namespaces</span>
</pre>
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/math_toolkit/conventions.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<a name="math_toolkit.conventions"></a><a class="link" href="conventions.html" title="Document Conventions">Document Conventions</a>
</h2></div></div></div>
<p>
<a class="indexterm" name="id945901"></a>
<a class="indexterm" name="id952340"></a>
</p>
<p>
This documentation aims to use of the following naming and formatting conventions.
Expand Down
10 changes: 7 additions & 3 deletions doc/html/math_toolkit/cubic_roots.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Math Toolkit 3.1.0">
<link rel="up" href="../root_finding.html" title="Chapter 10. Root Finding &amp; Minimization Algorithms">
<link rel="prev" href="roots_deriv.html" title="Root Finding With Derivatives: Newton-Raphson, Halley &amp; Schröder">
<link rel="next" href="root_finding_examples.html" title="Examples of Root-Finding (with and without derivatives)">
<link rel="next" href="quartic_roots.html" title="Roots of Quartic Polynomials">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
Expand All @@ -20,7 +20,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="roots_deriv.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../root_finding.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="root_finding_examples.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="roots_deriv.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../root_finding.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="quartic_roots.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
Expand All @@ -41,6 +41,10 @@ <h4>
<span class="comment">// Recall that for a numerically computed root r satisfying r = r⁎(1+ε) for the exact root r⁎ of a function p, |p(r)| ≲ ε|rṗ(r)|.</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span><span class="identifier">Real</span><span class="special">,</span> <span class="number">2</span><span class="special">&gt;</span> <span class="identifier">cubic_root_residual</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">b</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">d</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">root</span><span class="special">);</span>

<span class="comment">// Computes the condition number of rootfinding. Computed via Corless, A Graduate Introduction to Numerical Methods, Section 3.2.1:</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Real</span><span class="special">&gt;</span>
<span class="identifier">Real</span> <span class="identifier">cubic_root_condition_number</span><span class="special">(</span><span class="identifier">Real</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">b</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">c</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">d</span><span class="special">,</span> <span class="identifier">Real</span> <span class="identifier">root</span><span class="special">);</span>
<span class="special">}</span>
</pre>
<h4>
Expand Down Expand Up @@ -150,7 +154,7 @@ <h4>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="roots_deriv.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../root_finding.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="root_finding_examples.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
<a accesskey="p" href="roots_deriv.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../root_finding.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="quartic_roots.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/html/math_toolkit/dist_ref/dists/arcine_dist.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<span class="keyword">typedef</span> <span class="identifier">Policy</span> <span class="identifier">policy_type</span><span class="special">;</span>

<span class="comment">// Constructor from two range parameters, x_min and x_max:</span>
<span class="identifier">arcsine_distribution</span><span class="special">(</span><span class="identifier">RealType</span> <span class="identifier">x_min</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="identifier">x_max</span><span class="special">);</span>
<span class="identifier">arcsine_distribution</span><span class="special">(</span><span class="identifier">RealType</span> <span class="identifier">x_min</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="identifier">x_max</span> <span class="special">=</span> <span class="number">1</span><span class="special">);</span>

<span class="comment">// Range Parameter accessors:</span>
<span class="identifier">RealType</span> <span class="identifier">x_min</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
Expand Down
Loading

0 comments on commit b558996

Please sign in to comment.