Author: luc
Date: Mon Apr 25 09:23:30 2011
New Revision: 1096440
URL: http://svn.apache.org/viewvc?rev=1096440&view=rev
Log:
Fixed misleading javadoc, the user supplied min and max step size are
internally forced to positive and integration direction is handled later on.
Asking for a positive step size was superfluous.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdaptiveStepsizeIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince54Integrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince853Integrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/EmbeddedRungeKuttaIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/HighamHall54Integrator.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -146,10 +146,12 @@ public class AdamsBashforthIntegrator ex
/**
* Build an Adams-Bashforth integrator with the given order and step
control parameters.
* @param nSteps number of steps of the method excluding the one being
computed
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
@@ -166,10 +168,12 @@ public class AdamsBashforthIntegrator ex
/**
* Build an Adams-Bashforth integrator with the given order and step
control parameters.
* @param nSteps number of steps of the method excluding the one being
computed
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -39,10 +39,12 @@ public abstract class AdamsIntegrator ex
* @param name name of the method
* @param nSteps number of steps of the method excluding the one being
computed
* @param order order of the method
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
@@ -62,10 +64,12 @@ public abstract class AdamsIntegrator ex
* @param name name of the method
* @param nSteps number of steps of the method excluding the one being
computed
* @param order order of the method
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -162,10 +162,12 @@ public class AdamsMoultonIntegrator exte
/**
* Build an Adams-Moulton integrator with the given order and error
control parameters.
* @param nSteps number of steps of the method excluding the one being
computed
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
@@ -182,10 +184,12 @@ public class AdamsMoultonIntegrator exte
/**
* Build an Adams-Moulton integrator with the given order and error
control parameters.
* @param nSteps number of steps of the method excluding the one being
computed
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
* @exception IllegalArgumentException if order is 1 or less
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdaptiveStepsizeIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdaptiveStepsizeIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdaptiveStepsizeIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/AdaptiveStepsizeIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -92,10 +92,12 @@ public abstract class AdaptiveStepsizeIn
/** Build an integrator with the given stepsize bounds.
* The default step handler does nothing.
* @param name name of the method
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
@@ -122,10 +124,12 @@ public abstract class AdaptiveStepsizeIn
/** Build an integrator with the given stepsize bounds.
* The default step handler does nothing.
* @param name name of the method
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince54Integrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince54Integrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince54Integrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince54Integrator.java
Mon Apr 25 09:23:30 2011
@@ -93,10 +93,12 @@ public class DormandPrince54Integrator e
/** Simple constructor.
* Build a fifth order Dormand-Prince integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
@@ -109,10 +111,12 @@ public class DormandPrince54Integrator e
/** Simple constructor.
* Build a fifth order Dormand-Prince integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince853Integrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince853Integrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince853Integrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/DormandPrince853Integrator.java
Mon Apr 25 09:23:30 2011
@@ -205,10 +205,12 @@ public class DormandPrince853Integrator
/** Simple constructor.
* Build an eighth order Dormand-Prince integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
@@ -222,10 +224,12 @@ public class DormandPrince853Integrator
/** Simple constructor.
* Build an eighth order Dormand-Prince integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/EmbeddedRungeKuttaIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/EmbeddedRungeKuttaIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/EmbeddedRungeKuttaIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/EmbeddedRungeKuttaIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -99,10 +99,12 @@ public abstract class EmbeddedRungeKutta
* @param a internal weights from Butcher array (without the first empty row)
* @param b propagation weights for the high order method from Butcher array
* @param prototype prototype of the step interpolator to use
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
Mon Apr 25 09:23:30 2011
@@ -155,10 +155,12 @@ public class GraggBulirschStoerIntegrato
* Build a Gragg-Bulirsch-Stoer integrator with the given step
* bounds. All tuning parameters are set to their default
* values. The default step handler does nothing.
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/HighamHall54Integrator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/HighamHall54Integrator.java?rev=1096440&r1=1096439&r2=1096440&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/HighamHall54Integrator.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/nonstiff/HighamHall54Integrator.java
Mon Apr 25 09:23:30 2011
@@ -66,10 +66,12 @@ public class HighamHall54Integrator exte
/** Simple constructor.
* Build a fifth order Higham and Hall integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param scalAbsoluteTolerance allowed absolute error
* @param scalRelativeTolerance allowed relative error
*/
@@ -82,10 +84,12 @@ public class HighamHall54Integrator exte
/** Simple constructor.
* Build a fifth order Higham and Hall integrator with the given step bounds
- * @param minStep minimal step (must be positive even for backward
- * integration), the last step can be smaller than this
- * @param maxStep maximal step (must be positive even for backward
- * integration)
+ * @param minStep minimal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
+ * @param maxStep maximal step (sign is irrelevant, regardless of
+ * integration direction, forward or backward), the last step can
+ * be smaller than this
* @param vecAbsoluteTolerance allowed absolute error
* @param vecRelativeTolerance allowed relative error
*/
