diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html | 295 |
1 files changed, 295 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html new file mode 100644 index 0000000..60d622c --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html @@ -0,0 +1,295 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FieldStepInterpolator (Apache Commons Math 3.6.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FieldStepInterpolator (Apache Commons Math 3.6.1 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FieldStepInterpolator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="class in org.apache.commons.math3.ode.sampling"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" target="_top">Frames</a></li> +<li><a href="FieldStepInterpolator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.ode.sampling</div> +<h2 title="Interface FieldStepInterpolator" class="title">Interface FieldStepInterpolator<T extends <a href="../../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><T>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the field elements</dd></dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/ode/sampling/AbstractFieldStepInterpolator.html" title="class in org.apache.commons.math3.ode.sampling">AbstractFieldStepInterpolator</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">FieldStepInterpolator<T extends <a href="../../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><T>></span></pre> +<div class="block">This interface represents an interpolator over the last step + during an ODE integration. + + <p>The various ODE integrators provide objects implementing this + interface to the step handlers. These objects are often custom + objects tightly bound to the integrator internal algorithms. The + handlers can use these objects to retrieve the state vector at + intermediate times between the previous and the current grid points + (this feature is often called dense output).</p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.6</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderFieldIntegrator</code></a>, +<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldStepHandler</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html#getCurrentState()">getCurrentState</a></strong>()</code> +<div class="block">Get the state at current grid point time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html#getInterpolatedState(T)">getInterpolatedState</a></strong>(<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a> time)</code> +<div class="block">Get the state at interpolated time.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html#getPreviousState()">getPreviousState</a></strong>()</code> +<div class="block">Get the state at previous grid point time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html#isForward()">isForward</a></strong>()</code> +<div class="block">Check if the natural integration direction is forward.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPreviousState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreviousState</h4> +<pre><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>> getPreviousState()</pre> +<div class="block">Get the state at previous grid point time.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>state at previous grid point time</dd></dl> +</li> +</ul> +<a name="getCurrentState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentState</h4> +<pre><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>> getCurrentState()</pre> +<div class="block">Get the state at current grid point time.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>state at current grid point time</dd></dl> +</li> +</ul> +<a name="getInterpolatedState(org.apache.commons.math3.RealFieldElement)"> +<!-- --> +</a><a name="getInterpolatedState(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInterpolatedState</h4> +<pre><a href="../../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a>> getInterpolatedState(<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="type parameter in FieldStepInterpolator">T</a> time)</pre> +<div class="block">Get the state at interpolated time. + <p>Setting the time outside of the current step is allowed, but + should be used with care since the accuracy of the interpolator will + probably be very poor far from this step. This allowance has been + added to simplify implementation of search algorithms near the + step endpoints.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - time of the interpolated point</dd> +<dt><span class="strong">Returns:</span></dt><dd>state at interpolated time</dd></dl> +</li> +</ul> +<a name="isForward()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isForward</h4> +<pre>boolean isForward()</pre> +<div class="block">Check if the natural integration direction is forward. + <p>This method provides the integration direction as specified by + the integrator itself, it avoid some nasty problems in + degenerated cases like null steps due to cancellation at step + initialization, step control or discrete events + triggering.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the integration variable (time) increases during + integration</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FieldStepInterpolator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="class in org.apache.commons.math3.ode.sampling"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" target="_top">Frames</a></li> +<li><a href="FieldStepInterpolator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |