svn commit: r676891 - in /commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode: ./ nonstiff/

[lu...@apache.org]

Author: luc
Date: Tue Jul 15 04:53:23 2008
New Revision: 676891

URL: http://svn.apache.org/viewvc?rev=676891&view=rev
Log:
fixed javadoc related checkstyle errors

Modified:
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/ODEIntegrator.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/ODEIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/ODEIntegrator.java?rev=676891&r1=676890&r2=676891&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/ODEIntegrator.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/ODEIntegrator.java Tue Jul 15 04:53:23 2008
@@ -23,6 +23,14 @@
 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 @@
      */
     double getCurrentSignedStepsize();
 
-}
\ No newline at end of file
+}

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java?rev=676891&r1=676890&r2=676891&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java Tue Jul 15 04:53:23 2008
@@ -225,15 +225,17 @@
     }
 
     /** 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) {
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java?rev=676891&r1=676890&r2=676891&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthStepInterpolator.java Tue Jul 15 04:53:23 2008
@@ -120,6 +120,7 @@
     /** 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;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java?rev=676891&r1=676890&r2=676891&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonStepInterpolator.java Tue Jul 15 04:53:23 2008
@@ -120,6 +120,7 @@
     /** 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;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java?rev=676891&r1=676890&r2=676891&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java Tue Jul 15 04:53:23 2008
@@ -287,7 +287,7 @@
         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;