fixed javadoc related checkstyle errors

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/branches/MATH_2_0@676891 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2008-07-15 11:53:23 +00:00
parent 642e3f63f2
commit f745b46abf
5 changed files with 18 additions and 6 deletions

View File

@ -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();
}
}

View File

@ -225,15 +225,17 @@ public class AdamsBashforthIntegrator extends MultistepIntegrator {
}
/** Compute the backward differences coefficients array.
* <p>This is quite similar to the Pascal triangle, except for a
* (-1)<sup>i</sup> 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:</p>
* <p>This is quite similar to the Pascal triangle containing the
* binomial coefficiens, except for an additional (-1)<sup>i</sup> 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:</p>
* <pre>
* &nabla;<sup>0</sup> f<sub>n</sub> = f<sub>n</sub>
* &nabla;<sup>i+1</sup> f<sub>n</sub> = &nabla;<sup>i</sup>f<sub>n</sub> - &nabla;<sup>i</sup>f<sub>n-1</sub>
* </pre>
* @param order order of the integration method
* @return the coefficients array for backward differences
*/
static int[][] computeBackwardDifferencesArray(final int order) {

View File

@ -120,6 +120,7 @@ class AdamsBashforthStepInterpolator extends MultistepStepInterpolator {
/** Truncate a step.
* <p>Truncating a step is necessary when an event is triggered
* before the nominal end of the step.</p>
* @param truncatedEndTime end time of truncated step
*/
void truncateStep(final double truncatedEndTime) {
currentTime = truncatedEndTime;

View File

@ -120,6 +120,7 @@ class AdamsMoultonStepInterpolator extends MultistepStepInterpolator {
/** Truncate a step.
* <p>Truncating a step is necessary when an event is triggered
* before the nominal end of the step.</p>
* @param truncatedEndTime end time of truncated step
*/
void truncateStep(final double truncatedEndTime) {
currentTime = truncatedEndTime;

View File

@ -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;