diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html | 450 |
1 files changed, 450 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html new file mode 100644 index 0000000..ccc3782 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html @@ -0,0 +1,450 @@ +<!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>FieldStepNormalizer (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="FieldStepNormalizer (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/FieldStepNormalizer.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/FieldStepInterpolator.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/FixedStepHandler.html" title="interface 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/FieldStepNormalizer.html" target="_top">Frames</a></li> +<li><a href="FieldStepNormalizer.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class FieldStepNormalizer" class="title">Class FieldStepNormalizer<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"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.ode.sampling.FieldStepNormalizer<T></li> +</ul> +</li> +</ul> +<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 Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FieldStepNormalizer<T extends <a href="../../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><T>></span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><T></pre> +<div class="block">This class wraps an object implementing <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldFixedStepHandler</code></a> + into a <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldStepHandler</code></a>. + + <p>This wrapper allows to use fixed step handlers with general + integrators which cannot guaranty their integration steps will + remain constant and therefore only accept general step + handlers.</p> + + <p>The stepsize used is selected at construction time. The <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html#handleStep(org.apache.commons.math3.ode.FieldODEStateAndDerivative,%20boolean)"><code>handleStep</code></a> method of the underlying + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldFixedStepHandler</code></a> object is called at normalized times. The + normalized times can be influenced by the <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling"><code>StepNormalizerMode</code></a> and + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling"><code>StepNormalizerBounds</code></a>.</p> + + <p>There is no constraint on the integrator, it can use any time step + it needs (time steps longer or shorter than the fixed time step and + non-integer ratios are all allowed).</p> + + <p> + <table border="1" align="center"> + <tr BGCOLOR="#CCCCFF"><td colspan=6><font size="+2">Examples (step size = 0.5)</font></td></tr> + <tr BGCOLOR="#EEEEFF"><font size="+1"><td>Start time</td><td>End time</td> + <td>Direction</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling"><code>Mode</code></a></td> + <td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling"><code>Bounds</code></a></td><td>Output</td></font></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>0.8, 1.3, 1.8, 2.3, 2.8</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>0.3, 0.8, 1.3, 1.8, 2.3, 2.8</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>0.8, 1.3, 1.8, 2.3, 2.8, 3.1</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>0.3, 0.8, 1.3, 1.8, 2.3, 2.8, 3.1</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>0.3, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.1</td></tr> + <tr><td>0.3</td><td>3.1</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>0.3, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.1</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>0.0</td><td>3.0</td><td>forward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>2.6, 2.1, 1.6, 1.1, 0.6</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>3.1, 2.6, 2.1, 1.6, 1.1, 0.6</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>2.6, 2.1, 1.6, 1.1, 0.6, 0.3</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>3.1, 2.6, 2.1, 1.6, 1.1, 0.6, 0.3</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>3.1, 3.0, 2.5, 2.0, 1.5, 1.0, 0.5</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.3</td></tr> + <tr><td>3.1</td><td>0.3</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>3.1, 3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.3</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#NEITHER"><code>NEITHER</code></a></td><td>2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#LAST"><code>LAST</code></a></td><td>2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + <tr><td>3.0</td><td>0.0</td><td>backward</td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#MULTIPLES"><code>MULTIPLES</code></a></td><td><a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#BOTH"><code>BOTH</code></a></td><td>3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0</td></tr> + </table> + </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/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldStepHandler</code></a>, +<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling"><code>FieldFixedStepHandler</code></a>, +<a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling"><code>StepNormalizerMode</code></a>, +<a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling"><code>StepNormalizerBounds</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#FieldStepNormalizer(double,%20org.apache.commons.math3.ode.sampling.FieldFixedStepHandler)">FieldStepNormalizer</a></strong>(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler)</code> +<div class="block">Simple constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#FieldStepNormalizer(double,%20org.apache.commons.math3.ode.sampling.FieldFixedStepHandler,%20org.apache.commons.math3.ode.sampling.StepNormalizerBounds)">FieldStepNormalizer</a></strong>(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerBounds</a> bounds)</code> +<div class="block">Simple constructor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#FieldStepNormalizer(double,%20org.apache.commons.math3.ode.sampling.FieldFixedStepHandler,%20org.apache.commons.math3.ode.sampling.StepNormalizerMode)">FieldStepNormalizer</a></strong>(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerMode</a> mode)</code> +<div class="block">Simple constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#FieldStepNormalizer(double,%20org.apache.commons.math3.ode.sampling.FieldFixedStepHandler,%20org.apache.commons.math3.ode.sampling.StepNormalizerMode,%20org.apache.commons.math3.ode.sampling.StepNormalizerBounds)">FieldStepNormalizer</a></strong>(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerMode</a> mode, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerBounds</a> bounds)</code> +<div class="block">Simple constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#handleStep(org.apache.commons.math3.ode.sampling.FieldStepInterpolator,%20boolean)">handleStep</a></strong>(<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepInterpolator</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> interpolator, + boolean isLast)</code> +<div class="block">Handle the last accepted step</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html#init(org.apache.commons.math3.ode.FieldODEStateAndDerivative,%20T)">init</a></strong>(<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/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> initialState, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a> finalTime)</code> +<div class="block">Initialize step handler at the start of an ODE integration.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FieldStepNormalizer(double, org.apache.commons.math3.ode.sampling.FieldFixedStepHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FieldStepNormalizer</h4> +<pre>public FieldStepNormalizer(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler)</pre> +<div class="block">Simple constructor. Uses <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a> + mode, and <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a> bounds setting, for + backwards compatibility.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - fixed time step (sign is not used)</dd><dd><code>handler</code> - fixed time step handler to wrap</dd></dl> +</li> +</ul> +<a name="FieldStepNormalizer(double, org.apache.commons.math3.ode.sampling.FieldFixedStepHandler, org.apache.commons.math3.ode.sampling.StepNormalizerMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FieldStepNormalizer</h4> +<pre>public FieldStepNormalizer(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerMode</a> mode)</pre> +<div class="block">Simple constructor. Uses <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html#FIRST"><code>FIRST</code></a> + bounds setting.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - fixed time step (sign is not used)</dd><dd><code>handler</code> - fixed time step handler to wrap</dd><dd><code>mode</code> - step normalizer mode to use</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +<a name="FieldStepNormalizer(double, org.apache.commons.math3.ode.sampling.FieldFixedStepHandler, org.apache.commons.math3.ode.sampling.StepNormalizerBounds)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FieldStepNormalizer</h4> +<pre>public FieldStepNormalizer(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerBounds</a> bounds)</pre> +<div class="block">Simple constructor. Uses <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html#INCREMENT"><code>INCREMENT</code></a> + mode.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - fixed time step (sign is not used)</dd><dd><code>handler</code> - fixed time step handler to wrap</dd><dd><code>bounds</code> - step normalizer bounds setting to use</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +<a name="FieldStepNormalizer(double, org.apache.commons.math3.ode.sampling.FieldFixedStepHandler, org.apache.commons.math3.ode.sampling.StepNormalizerMode, org.apache.commons.math3.ode.sampling.StepNormalizerBounds)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FieldStepNormalizer</h4> +<pre>public FieldStepNormalizer(double h, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldFixedStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldFixedStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> handler, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerMode.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerMode</a> mode, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/StepNormalizerBounds.html" title="enum in org.apache.commons.math3.ode.sampling">StepNormalizerBounds</a> bounds)</pre> +<div class="block">Simple constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - fixed time step (sign is not used)</dd><dd><code>handler</code> - fixed time step handler to wrap</dd><dd><code>mode</code> - step normalizer mode to use</dd><dd><code>bounds</code> - step normalizer bounds setting to use</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(org.apache.commons.math3.ode.FieldODEStateAndDerivative,org.apache.commons.math3.RealFieldElement)"> +<!-- --> +</a><a name="init(org.apache.commons.math3.ode.FieldODEStateAndDerivative, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init(<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/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> initialState, + <a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a> finalTime)</pre> +<div class="block">Initialize step handler at the start of an ODE integration. + <p> + This method is called once at the start of the integration. It + may be used by the step handler to initialize some internal data + if needed. + </p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html#init(org.apache.commons.math3.ode.FieldODEStateAndDerivative,%20T)">init</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a> extends <a href="../../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>initialState</code> - initial time, state vector and derivative</dd><dd><code>finalTime</code> - target time for the integration</dd></dl> +</li> +</ul> +<a name="handleStep(org.apache.commons.math3.ode.sampling.FieldStepInterpolator, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleStep</h4> +<pre>public void handleStep(<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepInterpolator.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepInterpolator</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>> interpolator, + boolean isLast) + throws <a href="../../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a></pre> +<div class="block">Handle the last accepted step</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html#handleStep(org.apache.commons.math3.ode.sampling.FieldStepInterpolator,%20boolean)">handleStep</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a> extends <a href="../../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><<a href="../../../../../../org/apache/commons/math3/ode/sampling/FieldStepNormalizer.html" title="type parameter in FieldStepNormalizer">T</a>>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>interpolator</code> - interpolator for the last accepted step. For + efficiency purposes, the various integrators reuse the same + object on each call, so if the instance wants to keep it across + all calls (for example to provide at the end of the integration a + continuous model valid throughout the integration range), it + should build a local copy using the clone method and store this + copy.</dd><dd><code>isLast</code> - true if the step is the last one</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a></code> - if the interpolator throws one because + the number of functions evaluations is exceeded</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/FieldStepNormalizer.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/FieldStepInterpolator.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/FixedStepHandler.html" title="interface 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/FieldStepNormalizer.html" target="_top">Frames</a></li> +<li><a href="FieldStepNormalizer.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> |