You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by lu...@apache.org on 2011/10/01 21:41:34 UTC
svn commit: r1178076 - in
/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode:
ExpandableStatefulODE.java events/EventHandler.java
nonstiff/AdaptiveStepsizeIntegrator.java sampling/StepInterpolator.java
Author: luc
Date: Sat Oct 1 19:41:34 2011
New Revision: 1178076
URL: http://svn.apache.org/viewvc?rev=1178076&view=rev
Log:
Fixed javadoc
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/ExpandableStatefulODE.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/events/EventHandler.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/sampling/StepInterpolator.java
Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/ExpandableStatefulODE.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/ExpandableStatefulODE.java?rev=1178076&r1=1178075&r2=1178076&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/ExpandableStatefulODE.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/ExpandableStatefulODE.java Sat Oct 1 19:41:34 2011
@@ -67,7 +67,7 @@ public class ExpandableStatefulODE {
private List<SecondaryComponent> components;
/** Build an expandable set from its primary ODE set.
- * @param ode the primary set of differential equations to be integrated.
+ * @param primary the primary set of differential equations to be integrated.
*/
public ExpandableStatefulODE(final FirstOrderDifferentialEquations primary) {
final int n = primary.getDimension();
Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/events/EventHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/events/EventHandler.java?rev=1178076&r1=1178075&r2=1178076&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/events/EventHandler.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/events/EventHandler.java Sat Oct 1 19:41:34 2011
@@ -115,17 +115,17 @@ public interface EventHandler {
* or continue integration, possibly with a reset state or derivatives.</p>
* <ul>
- * <li>if {@link #STOP} is returned, the step handler will be called
+ * <li>if {@link Action#STOP} is returned, the step handler will be called
* with the <code>isLast</code> flag of the {@link
* org.apache.commons.math.ode.sampling.StepHandler#handleStep handleStep}
* method set to true and the integration will be stopped,</li>
- * <li>if {@link #RESET_STATE} is returned, the {@link #resetState
+ * <li>if {@link Action#RESET_STATE} is returned, the {@link #resetState
* resetState} method will be called once the step handler has
* finished its task, and the integrator will also recompute the
* derivatives,</li>
- * <li>if {@link #RESET_DERIVATIVES} is returned, the integrator
+ * <li>if {@link Action#RESET_DERIVATIVES} is returned, the integrator
* will recompute the derivatives,
- * <li>if {@link #CONTINUE} is returned, no specific action will
+ * <li>if {@link Action#CONTINUE} is returned, no specific action will
* be taken (apart from having called this method) and integration
* will continue.</li>
* </ul>
@@ -138,7 +138,7 @@ public interface EventHandler {
* <code>handleStep</code> afterwards. This scheduling allows the integrator to
* pass <code>true</code> as the <code>isLast</code> parameter to the step
* handler to make it aware the step will be the last one if this method
- * returns {@link #STOP}. As the interpolator may be used to navigate back
+ * returns {@link Action#STOP}. As the interpolator may be used to navigate back
* throughout the last step (as {@link
* org.apache.commons.math.ode.sampling.StepNormalizer StepNormalizer}
* does for example), user code called by this method and user
@@ -160,8 +160,8 @@ public interface EventHandler {
* when times increases around event (note that increase is measured with respect
* to physical time, not with respect to integration which may go backward in time)
* @return indication of what the integrator should do next, this
- * value must be one of {@link #STOP}, {@link #RESET_STATE},
- * {@link #RESET_DERIVATIVES} or {@link #CONTINUE}
+ * value must be one of {@link Action#STOP}, {@link Action#RESET_STATE},
+ * {@link Action#RESET_DERIVATIVES} or {@link Action#CONTINUE}
*/
Action eventOccurred(double t, double[] y, boolean increasing);
@@ -169,11 +169,11 @@ public interface EventHandler {
* <p>This method is called after the step handler has returned and
* before the next step is started, but only when {@link
- * #eventOccurred} has itself returned the {@link #RESET_STATE}
+ * #eventOccurred} has itself returned the {@link Action#RESET_STATE}
* indicator. It allows the user to reset the state vector for the
* next step, without perturbing the step handler of the finishing
* step. If the {@link #eventOccurred} never returns the {@link
- * #RESET_STATE} indicator, this function will never be called, and it is
+ * Action#RESET_STATE} indicator, this function will never be called, and it is
* safe to leave its body empty.</p>
* @param t current value of the independent <i>time</i> variable
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=1178076&r1=1178075&r2=1178076&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 Sat Oct 1 19:41:34 2011
@@ -45,7 +45,7 @@ import org.apache.commons.math.util.Fast
* <p>
* If the Ordinary Differential Equations is an {@link ExpandableStatefulODE
* extended ODE} rather than a {@link FirstOrderDifferentialEquations basic ODE}, then
- * <em>only</em> the {@link ExpandableStatefulODE#getMainSet() main part}
+ * <em>only</em> the {@link ExpandableStatefulODE#getPrimaryState() primary part}
* of the state vector is used for stepsize control, not the complete state vector.
* </p>
*
Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/sampling/StepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/sampling/StepInterpolator.java?rev=1178076&r1=1178075&r2=1178076&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/sampling/StepInterpolator.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/ode/sampling/StepInterpolator.java Sat Oct 1 19:41:34 2011
@@ -112,7 +112,7 @@ public interface StepInterpolator extend
* @return interpolated secondary state at the current interpolation date
* @see #getInterpolatedState()
* @see #getInterpolatedDerivatives()
- * @see #getInterpolatedSecondaryDerivatives(String)
+ * @see #getInterpolatedSecondaryDerivatives(int)
* @see #setInterpolatedTime(double)
* @since 3.0
*/
@@ -129,7 +129,7 @@ public interface StepInterpolator extend
* @return interpolated secondary derivatives at the current interpolation date
* @see #getInterpolatedState()
* @see #getInterpolatedDerivatives()
- * @see #getInterpolatedSecondaryState(String)
+ * @see #getInterpolatedSecondaryState(int)
* @see #setInterpolatedTime(double)
* @since 3.0
*/