Updated the online docs

berndporr · Jan 6, 2023 · 9ef2a04 · 9ef2a04
1 parent d2a3465
commit 9ef2a04
Show file tree

Hide file tree

Showing 465 changed files with 6,477 additions and 6,304 deletions.
diff --git a/docs/Biquad_8h_source.html b/docs/Biquad_8h_source.html
diff --git a/docs/Butterworth_8h_source.html b/docs/Butterworth_8h_source.html
diff --git a/docs/Cascade_8h_source.html b/docs/Cascade_8h_source.html
diff --git a/docs/ChebyshevII_8h_source.html b/docs/ChebyshevII_8h_source.html
diff --git a/docs/ChebyshevI_8h_source.html b/docs/ChebyshevI_8h_source.html
diff --git a/docs/Common_8h_source.html b/docs/Common_8h_source.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.17"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>iir1: iir/Common.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,10 +29,10 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.17 -->
+<!-- Generated by Doxygen 1.9.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
@@ -79,38 +79,50 @@
 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160; </div>
 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#ifdef _MSC_VER</span></div>
 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">#  pragma warning (disable: 4100)</span></div>
-<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
-<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">// This exports the classes/structures to the windows DLL</span></div>
-<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">#ifdef _WIN32</span></div>
-<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#define DllExport   __declspec( dllexport )</span></div>
-<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="preprocessor">#define _CRT_SECURE_NO_WARNINGS</span></div>
-<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="preprocessor">#else</span></div>
-<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#define DllExport</span></div>
-<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#endif</span></div>
-<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160; </div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
+<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#  ifndef _CRT_SECURE_NO_WARNINGS</span></div>
+<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#    define _CRT_SECURE_NO_WARNINGS</span></div>
+<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#  endif</span></div>
+<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160; </div>
+<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">// This exports the classes/structures to the windows DLL</span></div>
+<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="preprocessor">#if defined(_WIN32) &amp;&amp; defined(iir_EXPORTS)</span></div>
+<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#define IIR_EXPORT __declspec( dllexport )</span></div>
+<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#else</span></div>
+<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#define IIR_EXPORT</span></div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
-<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#include &lt;cassert&gt;</span></div>
-<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#include &lt;cfloat&gt;</span></div>
-<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
-<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#include &lt;complex&gt;</span></div>
-<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div>
-<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
-<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
-<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
-<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160; </div>
-<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> orderTooHigh[] = <span class="stringliteral">&quot;Requested order is too high. Provide a higher order for the template.&quot;</span>;</div>
-<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
-<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="preprocessor">#define DEFAULT_FILTER_ORDER 4</span></div>
-<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160; </div>
-<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160; </div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#include &lt;cassert&gt;</span></div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#include &lt;cfloat&gt;</span></div>
+<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div>
+<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor">#include &lt;complex&gt;</span></div>
+<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div>
+<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
+<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="preprocessor">#include &lt;stdexcept&gt;</span> <span class="comment">// for invalid_argument</span></div>
+<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
+<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> orderTooHigh[] = <span class="stringliteral">&quot;Requested order is too high. Provide a higher order for the template.&quot;</span>;</div>
+<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
+<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="preprocessor">#define DEFAULT_FILTER_ORDER 4</span></div>
+<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160; </div>
+<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> throw_invalid_argument(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg) {</div>
+<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160; </div>
+<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="preprocessor">#ifndef IIR1_NO_EXCEPTIONS</span></div>
+<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keywordflow">throw</span> std::invalid_argument(msg);</div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#else</span></div>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    (void) msg; <span class="comment">// Discard parameter</span></div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    abort();</div>
+<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160; </div>
+<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;}</div>
+<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160; </div>
+<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Dec 7 2021 07:58:51 for iir1 by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.17
+Generated on Fri Jan 6 2023 23:53:32 for iir1 by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 </small></address>
 </body>
 </html>
diff --git a/docs/Custom_8h_source.html b/docs/Custom_8h_source.html
@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.17"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>iir1: iir/Custom.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,10 +29,10 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.17 -->
+<!-- Generated by Doxygen 1.9.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
@@ -101,12 +101,12 @@
 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;};</div>
 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160; </div>
 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="keyword">template</span> &lt;<span class="keywordtype">int</span> NSOS, <span class="keyword">class</span> StateType = DEFAULT_STATE&gt;</div>
-<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structIir_1_1Custom_1_1SOSCascade.html">   90</a></span>&#160;<span class="keyword">struct </span>DllExport <a class="code" href="structIir_1_1Custom_1_1SOSCascade.html">SOSCascade</a> : <a class="code" href="classIir_1_1CascadeStages.html">CascadeStages</a>&lt;NSOS,StateType&gt;</div>
+<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structIir_1_1Custom_1_1SOSCascade.html">   90</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIir_1_1Custom_1_1SOSCascade.html">SOSCascade</a> : <a class="code" href="classIir_1_1CascadeStages.html">CascadeStages</a>&lt;NSOS,StateType&gt;</div>
 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;{</div>
-<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        <a class="code" href="structIir_1_1Custom_1_1SOSCascade.html">SOSCascade</a>();</div>
+<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="structIir_1_1Custom_1_1SOSCascade.html#a04671c1c84cacaf1c822adeb850ccc63">   96</a></span>&#160;        <a class="code" href="structIir_1_1Custom_1_1SOSCascade.html#a04671c1c84cacaf1c822adeb850ccc63">SOSCascade</a>() = <span class="keywordflow">default</span>;</div>
 <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="structIir_1_1Custom_1_1SOSCascade.html#a60654fe4bd861799dff82a6dce9dfd42">  107</a></span>&#160;        <a class="code" href="structIir_1_1Custom_1_1SOSCascade.html#a60654fe4bd861799dff82a6dce9dfd42">SOSCascade</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> (&amp;sosCoefficients)[NSOS][6]) {</div>
 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                <a class="code" href="classIir_1_1CascadeStages.html#a56d24da4cf09f898b534b1b05578244d">CascadeStages&lt;NSOS,StateType&gt;::setup</a>(sosCoefficients);</div>
-<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        };</div>
+<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        }</div>
 <div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="structIir_1_1Custom_1_1SOSCascade.html#aae603eb1bd4330411a6003e09ba36efc">  120</a></span>&#160;        <span class="keywordtype">void</span> <a class="code" href="structIir_1_1Custom_1_1SOSCascade.html#aae603eb1bd4330411a6003e09ba36efc">setup</a> (<span class="keyword">const</span> <span class="keywordtype">double</span> (&amp;sosCoefficients)[NSOS][6]) {</div>
 <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;                <a class="code" href="classIir_1_1CascadeStages.html#a56d24da4cf09f898b534b1b05578244d">CascadeStages&lt;NSOS,StateType&gt;::setup</a>(sosCoefficients);</div>
 <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        }</div>
@@ -117,21 +117,20 @@
 <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;}</div>
 <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160; </div>
 <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="preprocessor">#endif</span></div>
-</div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="aclassIir_1_1Biquad_html"><div class="ttname"><a href="classIir_1_1Biquad.html">Iir::Biquad</a></div><div class="ttdef"><b>Definition:</b> Biquad.h:52</div></div>
-<div class="ttc" id="astructIir_1_1Custom_1_1SOSCascade_html"><div class="ttname"><a href="structIir_1_1Custom_1_1SOSCascade.html">Iir::Custom::SOSCascade</a></div><div class="ttdef"><b>Definition:</b> Custom.h:90</div></div>
-<div class="ttc" id="aclassIir_1_1CascadeStages_html"><div class="ttname"><a href="classIir_1_1CascadeStages.html">Iir::CascadeStages</a></div><div class="ttdef"><b>Definition:</b> Cascade.h:127</div></div>
-<div class="ttc" id="aclassIir_1_1CascadeStages_html_a56d24da4cf09f898b534b1b05578244d"><div class="ttname"><a href="classIir_1_1CascadeStages.html#a56d24da4cf09f898b534b1b05578244d">Iir::CascadeStages::setup</a></div><div class="ttdeci">void setup(const double(&amp;sosCoefficients)[MaxStages][6])</div><div class="ttdef"><b>Definition:</b> Cascade.h:144</div></div>
-<div class="ttc" id="astructIir_1_1Custom_1_1TwoPole_html"><div class="ttname"><a href="structIir_1_1Custom_1_1TwoPole.html">Iir::Custom::TwoPole</a></div><div class="ttdef"><b>Definition:</b> Custom.h:75</div></div>
+<div class="ttc" id="aclassIir_1_1CascadeStages_html"><div class="ttname"><a href="classIir_1_1CascadeStages.html">Iir::CascadeStages</a></div><div class="ttdef"><b>Definition:</b> Cascade.h:114</div></div>
+<div class="ttc" id="aclassIir_1_1CascadeStages_html_a56d24da4cf09f898b534b1b05578244d"><div class="ttname"><a href="classIir_1_1CascadeStages.html#a56d24da4cf09f898b534b1b05578244d">Iir::CascadeStages::setup</a></div><div class="ttdeci">void setup(const double(&amp;sosCoefficients)[MaxStages][6])</div><div class="ttdef"><b>Definition:</b> Cascade.h:136</div></div>
+<div class="ttc" id="anamespaceIir_html"><div class="ttname"><a href="namespaceIir.html">Iir</a></div><div class="ttdef"><b>Definition:</b> Biquad.cpp:40</div></div>
+<div class="ttc" id="astructIir_1_1Custom_1_1OnePole_html"><div class="ttname"><a href="structIir_1_1Custom_1_1OnePole.html">Iir::Custom::OnePole</a></div><div class="ttdef"><b>Definition:</b> Custom.h:62</div></div>
+<div class="ttc" id="astructIir_1_1Custom_1_1SOSCascade_html"><div class="ttname"><a href="structIir_1_1Custom_1_1SOSCascade.html">Iir::Custom::SOSCascade</a></div><div class="ttdef"><b>Definition:</b> Custom.h:91</div></div>
+<div class="ttc" id="astructIir_1_1Custom_1_1SOSCascade_html_a04671c1c84cacaf1c822adeb850ccc63"><div class="ttname"><a href="structIir_1_1Custom_1_1SOSCascade.html#a04671c1c84cacaf1c822adeb850ccc63">Iir::Custom::SOSCascade::SOSCascade</a></div><div class="ttdeci">SOSCascade()=default</div></div>
 <div class="ttc" id="astructIir_1_1Custom_1_1SOSCascade_html_a60654fe4bd861799dff82a6dce9dfd42"><div class="ttname"><a href="structIir_1_1Custom_1_1SOSCascade.html#a60654fe4bd861799dff82a6dce9dfd42">Iir::Custom::SOSCascade::SOSCascade</a></div><div class="ttdeci">SOSCascade(const double(&amp;sosCoefficients)[NSOS][6])</div><div class="ttdef"><b>Definition:</b> Custom.h:107</div></div>
-<div class="ttc" id="anamespaceIir_html"><div class="ttname"><a href="namespaceIir.html">Iir</a></div><div class="ttdef"><b>Definition:</b> Biquad.cpp:41</div></div>
 <div class="ttc" id="astructIir_1_1Custom_1_1SOSCascade_html_aae603eb1bd4330411a6003e09ba36efc"><div class="ttname"><a href="structIir_1_1Custom_1_1SOSCascade.html#aae603eb1bd4330411a6003e09ba36efc">Iir::Custom::SOSCascade::setup</a></div><div class="ttdeci">void setup(const double(&amp;sosCoefficients)[NSOS][6])</div><div class="ttdef"><b>Definition:</b> Custom.h:120</div></div>
-<div class="ttc" id="astructIir_1_1Custom_1_1OnePole_html"><div class="ttname"><a href="structIir_1_1Custom_1_1OnePole.html">Iir::Custom::OnePole</a></div><div class="ttdef"><b>Definition:</b> Custom.h:61</div></div>
+<div class="ttc" id="astructIir_1_1Custom_1_1TwoPole_html"><div class="ttname"><a href="structIir_1_1Custom_1_1TwoPole.html">Iir::Custom::TwoPole</a></div><div class="ttdef"><b>Definition:</b> Custom.h:76</div></div>
+</div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Dec 7 2021 07:58:51 for iir1 by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.17
+Generated on Fri Jan 6 2023 23:53:32 for iir1 by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 </small></address>
 </body>
 </html>