deploy: 2489475

Author: kmilo17pet

classqlibs_1_1derivative-members.html

@@ -153,8 +153,9 @@
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#ac1cbaf9ad49a7802dbf17ee6fd1a60b6">qlibs::nState::operator()</a>(void) const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a5cee75054a5b36c68371ccfbe5195ec5">setDerivationMethod</a>(derivationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a94a03478ba137ed5e057a331c116896b">setIntegrationMethod</a>(integrationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1derivative.html#a179d2de9bf7f07c58c8eee6fbfdefb0a">~derivative</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1derivative.html">qlibs::derivative</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a3905519ba64f0e937b7be3a595cab034">~nState</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a102cacbb17c1f53ebcc763d82d021d5d">setSaturation</a>(const real_t minV, const real_t maxV) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1derivative.html#a179d2de9bf7f07c58c8eee6fbfdefb0a">~derivative</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1derivative.html">qlibs::derivative</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a3905519ba64f0e937b7be3a595cab034">~nState</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

classqlibs_1_1derivative.html

@@ -190,6 +190,9 @@
 <tr class="memitem:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state" id="r_a5cee75054a5b36c68371ccfbe5195ec5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#a5cee75054a5b36c68371ccfbe5195ec5">setDerivationMethod</a> (<a class="el" href="group__qnuma.html#ga1407622c3f944440d8d0aac8393dbcc4">derivationMethod</a> m) noexcept</td></tr>
 <tr class="memdesc:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the numerical derivation method.  <br /></td></tr>
 <tr class="separator:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state" id="r_a102cacbb17c1f53ebcc763d82d021d5d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#a102cacbb17c1f53ebcc763d82d021d5d">setSaturation</a> (const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> minV, const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> maxV) noexcept</td></tr>
+<tr class="memdesc:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the saturation limits for the integrator output.  <br /></td></tr>
+<tr class="separator:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state" id="r_ac1cbaf9ad49a7802dbf17ee6fd1a60b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#ac1cbaf9ad49a7802dbf17ee6fd1a60b6">operator()</a> (void) const noexcept</td></tr>
 <tr class="memdesc:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the state.  <br /></td></tr>
 <tr class="separator:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>

classqlibs_1_1integrator-members.html

@@ -153,7 +153,7 @@
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1integrator.html#a4b5ff8dab60b5cb98e41dd6c0c94dc7a">operator()</a>() const</td><td class="entry"><a class="el" href="classqlibs_1_1integrator.html">qlibs::integrator</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a5cee75054a5b36c68371ccfbe5195ec5">setDerivationMethod</a>(derivationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a94a03478ba137ed5e057a331c116896b">setIntegrationMethod</a>(integrationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1integrator.html#a5907effbd80bc9be4c831713ab1a7030">setSaturation</a>(const real_t minV, const real_t maxV) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1integrator.html">qlibs::integrator</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a102cacbb17c1f53ebcc763d82d021d5d">setSaturation</a>(const real_t minV, const real_t maxV) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1integrator.html#a96ec5d13adb463a2688794d1e8ba9190">~integrator</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1integrator.html">qlibs::integrator</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a3905519ba64f0e937b7be3a595cab034">~nState</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->

classqlibs_1_1integrator.html

@@ -166,9 +166,6 @@
 <tr class="memitem:ae34a074b2a9dd7b086602fb3569705e1" id="r_ae34a074b2a9dd7b086602fb3569705e1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae34a074b2a9dd7b086602fb3569705e1">integrator</a> (const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> timeStep, const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> initialCondition=0.0_re)</td></tr>
 <tr class="memdesc:ae34a074b2a9dd7b086602fb3569705e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an integrator block with a given <em class="arg">timeStep</em> time and optional initial condition.  <br /></td></tr>
 <tr class="separator:ae34a074b2a9dd7b086602fb3569705e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5907effbd80bc9be4c831713ab1a7030" id="r_a5907effbd80bc9be4c831713ab1a7030"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5907effbd80bc9be4c831713ab1a7030">setSaturation</a> (const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> minV, const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> maxV) noexcept</td></tr>
-<tr class="memdesc:a5907effbd80bc9be4c831713ab1a7030"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the saturation limits for the integrator output.  <br /></td></tr>
-<tr class="separator:a5907effbd80bc9be4c831713ab1a7030"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a68a16214a5ab21e6414e538a33ea9fbe" id="r_a68a16214a5ab21e6414e538a33ea9fbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a68a16214a5ab21e6414e538a33ea9fbe">operator()</a> (const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> xDot)</td></tr>
 <tr class="memdesc:a68a16214a5ab21e6414e538a33ea9fbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs one step of numerical integration.  <br /></td></tr>
 <tr class="separator:a68a16214a5ab21e6414e538a33ea9fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -196,6 +193,9 @@
 <tr class="memitem:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state" id="r_a5cee75054a5b36c68371ccfbe5195ec5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#a5cee75054a5b36c68371ccfbe5195ec5">setDerivationMethod</a> (<a class="el" href="group__qnuma.html#ga1407622c3f944440d8d0aac8393dbcc4">derivationMethod</a> m) noexcept</td></tr>
 <tr class="memdesc:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the numerical derivation method.  <br /></td></tr>
 <tr class="separator:a5cee75054a5b36c68371ccfbe5195ec5 inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state" id="r_a102cacbb17c1f53ebcc763d82d021d5d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#a102cacbb17c1f53ebcc763d82d021d5d">setSaturation</a> (const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> minV, const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a> maxV) noexcept</td></tr>
+<tr class="memdesc:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the saturation limits for the integrator output.  <br /></td></tr>
+<tr class="separator:a102cacbb17c1f53ebcc763d82d021d5d inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state" id="r_ac1cbaf9ad49a7802dbf17ee6fd1a60b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqlibs_1_1n_state.html#ac1cbaf9ad49a7802dbf17ee6fd1a60b6">operator()</a> (void) const noexcept</td></tr>
 <tr class="memdesc:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the state.  <br /></td></tr>
 <tr class="separator:ac1cbaf9ad49a7802dbf17ee6fd1a60b6 inherit pub_methods_classqlibs_1_1n_state"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -306,46 +306,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a68a16214a5ab21e6414e538a
 <dl class="section return"><dt>Returns</dt><dd>The integrated value (i.e., the output of the integrator) after applying saturation. </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>This should be called at intervals equal to the time step provided in the constructor. </dd></dl>
 
-</div>
-</div>
-<a id="a5907effbd80bc9be4c831713ab1a7030" name="a5907effbd80bc9be4c831713ab1a7030"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a5907effbd80bc9be4c831713ab1a7030">&#9670;&#160;</a></span>setSaturation()</h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
-      <table class="memname">
-        <tr>
-          <td class="memname">bool integrator::setSaturation </td>
-          <td>(</td>
-          <td class="paramtype">const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a></td>          <td class="paramname"><span class="paramname"><em>minV</em></span>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">const <a class="el" href="namespaceqlibs.html#aeca7cb28a6516edf7d0ad96ef698918e">real_t</a></td>          <td class="paramname"><span class="paramname"><em>maxV</em></span>&#160;)</td>
-        </tr>
-      </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span>  </td>
-  </tr>
-</table>
-</div><div class="memdoc">
-
-<p>Sets the saturation limits for the integrator output. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">minV</td><td>The minimum value the output can reach. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">maxV</td><td>The maximum value the output can reach. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the limits are valid and applied; <code>false</code> otherwise (e.g., minV &gt; maxV). </dd></dl>
-<dl class="section note"><dt>Note</dt><dd>If not set, the output is unbounded. </dd></dl>
-
 </div>
 </div>
 </div><!-- contents -->

classqlibs_1_1integrator.js

@@ -3,6 +3,5 @@ var classqlibs_1_1integrator =
     [ "~integrator", "classqlibs_1_1integrator.html#a96ec5d13adb463a2688794d1e8ba9190", null ],
     [ "integrator", "classqlibs_1_1integrator.html#ae34a074b2a9dd7b086602fb3569705e1", null ],
     [ "operator()", "classqlibs_1_1integrator.html#a4b5ff8dab60b5cb98e41dd6c0c94dc7a", null ],
-    [ "operator()", "classqlibs_1_1integrator.html#a68a16214a5ab21e6414e538a33ea9fbe", null ],
-    [ "setSaturation", "classqlibs_1_1integrator.html#a5907effbd80bc9be4c831713ab1a7030", null ]
+    [ "operator()", "classqlibs_1_1integrator.html#a68a16214a5ab21e6414e538a33ea9fbe", null ]
 ];

classqlibs_1_1n_state-members.html

@@ -151,7 +151,8 @@
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#ac1cbaf9ad49a7802dbf17ee6fd1a60b6">operator()</a>(void) const noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a5cee75054a5b36c68371ccfbe5195ec5">setDerivationMethod</a>(derivationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a94a03478ba137ed5e057a331c116896b">setIntegrationMethod</a>(integrationMethod m) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a3905519ba64f0e937b7be3a595cab034">~nState</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a102cacbb17c1f53ebcc763d82d021d5d">setSaturation</a>(const real_t minV, const real_t maxV) noexcept</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classqlibs_1_1n_state.html#a3905519ba64f0e937b7be3a595cab034">~nState</a>()</td><td class="entry"><a class="el" href="classqlibs_1_1n_state.html">qlibs::nState</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->