Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added getInterpolatedSecondaryDerivatives to ContinuousOutputModel. 

This method is a close relative to getInterpolatedDerivatives, but is
associated with the secondary state.

JIRA: MATH-1160
This commit is contained in:
Luc Maisonobe 2014-10-22 21:40:32 +02:00
parent f8e6bc8ec7
commit 45ae5c7e42
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/main/java/org/apache/commons/math3/ode/ContinuousOutputModel.java
View File

@ -346,6 +346,7 @@ public class ContinuousOutputModel
* @see #setInterpolatedTime(double) * @see #setInterpolatedTime(double)
* @see #getInterpolatedDerivatives() * @see #getInterpolatedDerivatives()
* @see #getInterpolatedSecondaryState(int) * @see #getInterpolatedSecondaryState(int)
* @see #getInterpolatedSecondaryDerivatives(int)
*/ */
public double[] getInterpolatedState() throws MaxCountExceededException { public double[] getInterpolatedState() throws MaxCountExceededException {
return steps.get(index).getInterpolatedState(); return steps.get(index).getInterpolatedState();
@ -362,6 +363,7 @@ public class ContinuousOutputModel
* @see #setInterpolatedTime(double) * @see #setInterpolatedTime(double)
* @see #getInterpolatedState() * @see #getInterpolatedState()
* @see #getInterpolatedSecondaryState(int) * @see #getInterpolatedSecondaryState(int)
* @see #getInterpolatedSecondaryDerivatives(int)
* @since 3.4 * @since 3.4
*/ */
public double[] getInterpolatedDerivatives() throws MaxCountExceededException { public double[] getInterpolatedDerivatives() throws MaxCountExceededException {
@ -381,6 +383,7 @@ public class ContinuousOutputModel
* @see #setInterpolatedTime(double) * @see #setInterpolatedTime(double)
* @see #getInterpolatedState() * @see #getInterpolatedState()
* @see #getInterpolatedDerivatives() * @see #getInterpolatedDerivatives()
* @see #getInterpolatedSecondaryDerivatives(int)
* @since 3.2 * @since 3.2
* @exception MaxCountExceededException if the number of functions evaluations is exceeded * @exception MaxCountExceededException if the number of functions evaluations is exceeded
*/ */
@ -389,6 +392,28 @@ public class ContinuousOutputModel
return steps.get(index).getInterpolatedSecondaryState(secondaryStateIndex); return steps.get(index).getInterpolatedSecondaryState(secondaryStateIndex);
} }
/** Get the interpolated secondary derivatives corresponding to the secondary equations.
* <p>The returned vector is a reference to a reused array, so
* it should not be modified and it should be copied if it needs
* to be preserved across several calls to the associated
* {@link #setInterpolatedTime(double)} method.</p>
* @param secondaryStateIndex index of the secondary set, as returned by {@link
* org.apache.commons.math3.ode.ExpandableStatefulODE#addSecondaryEquations(
* org.apache.commons.math3.ode.SecondaryEquations)
* ExpandableStatefulODE.addSecondaryEquations(SecondaryEquations)}
* @return interpolated secondary derivatives at the current interpolation date
* @see #setInterpolatedTime(double)
* @see #getInterpolatedState()
* @see #getInterpolatedDerivatives()
* @see #getInterpolatedSecondaryState(int)
* @since 3.4
* @exception MaxCountExceededException if the number of functions evaluations is exceeded
*/
public double[] getInterpolatedSecondaryDerivatives(final int secondaryStateIndex)
throws MaxCountExceededException {
return steps.get(index).getInterpolatedSecondaryDerivatives(secondaryStateIndex);
}
/** Compare a step interval and a double. /** Compare a step interval and a double.
* @param time point to locate * @param time point to locate
* @param interval step interval * @param interval step interval