diff --git a/src/java/org/apache/commons/math/ode/ODEIntegrator.java b/src/java/org/apache/commons/math/ode/ODEIntegrator.java index 6346bb494..a1fe60d5a 100644 --- a/src/java/org/apache/commons/math/ode/ODEIntegrator.java +++ b/src/java/org/apache/commons/math/ode/ODEIntegrator.java @@ -23,6 +23,14 @@ import java.util.Collection; import org.apache.commons.math.ode.events.EventHandler; import org.apache.commons.math.ode.sampling.StepHandler; +/** + * This interface defines the common parts shared by integrators + * for first and second order differential equations. + * @see FirstOrderIntegrator + * @see SecondOrderIntegrator + * @version $Revision$ $Date$ + * @since 2.0 + */ public interface ODEIntegrator extends Serializable { /** Get the name of the method. @@ -106,4 +114,4 @@ public interface ODEIntegrator extends Serializable { */ double getCurrentSignedStepsize(); -} \ No newline at end of file +} diff --git a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java index 2e44d5bc9..65ba7c33a 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java @@ -225,15 +225,17 @@ public class AdamsBashforthIntegrator extends MultistepIntegrator { } /** Compute the backward differences coefficients array. - *

This is quite similar to the Pascal triangle, except for a - * (-1)i sign. We use a straightforward approach here, - * since we don't expect this to be run too many times with too - * high k. It is based on the recurrence relations:

+ *

This is quite similar to the Pascal triangle containing the + * binomial coefficiens, except for an additional (-1)i sign. + * We use a straightforward approach here, since we don't expect this to + * be run too many times with too high k. It is based on the recurrence + * relations:

*
      *   ∇0 fn = fn
      *   ∇i+1 fn = ∇ifn - ∇ifn-1
      * 
* @param order order of the integration method + * @return the coefficients array for backward differences */ static int[][] computeBackwardDifferencesArray(final int order) { diff --git a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java index 0d46419dc..01f35ff4b 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java @@ -120,6 +120,7 @@ class AdamsBashforthStepInterpolator extends MultistepStepInterpolator { /** Truncate a step. *

Truncating a step is necessary when an event is triggered * before the nominal end of the step.

+ * @param truncatedEndTime end time of truncated step */ void truncateStep(final double truncatedEndTime) { currentTime = truncatedEndTime; diff --git a/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java b/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java index 35ed7d98a..4e41252f0 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java @@ -120,6 +120,7 @@ class AdamsMoultonStepInterpolator extends MultistepStepInterpolator { /** Truncate a step. *

Truncating a step is necessary when an event is triggered * before the nominal end of the step.

+ * @param truncatedEndTime end time of truncated step */ void truncateStep(final double truncatedEndTime) { currentTime = truncatedEndTime; diff --git a/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java b/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java index 4991e8a9d..b528e2170 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java @@ -287,7 +287,7 @@ public abstract class MultistepIntegrator extends AbstractIntegrator { private double[] finalState; /** Build a new instance. - * @param number of steps to store + * @param n number of steps to store */ public StoringStepHandler(final int n) { this.n = n;