fixed Javadoc.
Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/5672ebe9 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/5672ebe9 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/5672ebe9 Branch: refs/heads/master Commit: 5672ebe9123cd0c97524f95bcce6d8d634142cc8 Parents: 771eb6a Author: Luc Maisonobe <[email protected]> Authored: Wed Jan 6 13:29:26 2016 +0100 Committer: Luc Maisonobe <[email protected]> Committed: Wed Jan 6 13:29:26 2016 +0100 ---------------------------------------------------------------------- .../apache/commons/math4/ode/AbstractFieldIntegrator.java | 4 ++-- .../commons/math4/ode/ContinuousOutputFieldModel.java | 9 ++++----- .../apache/commons/math4/ode/FieldFirstOrderIntegrator.java | 2 +- .../java/org/apache/commons/math4/ode/FieldODEState.java | 2 +- .../commons/math4/ode/FieldODEStateAndDerivative.java | 2 +- .../math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java | 4 ++-- .../math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java | 2 +- 7 files changed, 12 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/AbstractFieldIntegrator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/AbstractFieldIntegrator.java b/src/main/java/org/apache/commons/math4/ode/AbstractFieldIntegrator.java index b4f321c..81f4085 100644 --- a/src/main/java/org/apache/commons/math4/ode/AbstractFieldIntegrator.java +++ b/src/main/java/org/apache/commons/math4/ode/AbstractFieldIntegrator.java @@ -246,8 +246,8 @@ public abstract class AbstractFieldIntegrator<T extends RealFieldElement<T>> imp * @exception DimensionMismatchException if arrays dimensions do not match equations settings * @exception MaxCountExceededException if the number of functions evaluations is exceeded * @exception NullPointerException if the ODE equations have not been set (i.e. if this method - * is called outside of a call to {@link #integrate(ExpandableStatefulODE, double)} or {@link - * #integrate(FirstOrderDifferentialEquations, double, double[], double, double[])}) + * is called outside of a call to {@link #integrate(FieldExpandableODE, FieldODEState, + * RealFieldElement) integrate} */ public T[] computeDerivatives(final T t, final T[] y) throws DimensionMismatchException, MaxCountExceededException, NullPointerException { http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/ContinuousOutputFieldModel.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/ContinuousOutputFieldModel.java b/src/main/java/org/apache/commons/math4/ode/ContinuousOutputFieldModel.java index f26fded..e9a1a29 100644 --- a/src/main/java/org/apache/commons/math4/ode/ContinuousOutputFieldModel.java +++ b/src/main/java/org/apache/commons/math4/ode/ContinuousOutputFieldModel.java @@ -38,11 +38,10 @@ import org.apache.commons.math4.util.FastMath; * view. It is called iteratively during the integration process and * stores a copy of all steps information in a sorted collection for * later use. Once the integration process is over, the user can use - * the {@link #setInterpolatedTime setInterpolatedTime} and {@link - * #getInterpolatedState getInterpolatedState} to retrieve this - * information at any time. It is important to wait for the - * integration to be over before attempting to call {@link - * #setInterpolatedTime setInterpolatedTime} because some internal + * the {@link #getInterpolatedState(RealFieldElement) getInterpolatedState} + * method to retrieve this information at any time. It is important to wait + * for the integration to be over before attempting to call {@link + * #getInterpolatedState(RealFieldElement)} because some internal * variables are set only once the last step has been handled.</p> * * <p>This is useful for example if the main loop of the user http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/FieldFirstOrderIntegrator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/FieldFirstOrderIntegrator.java b/src/main/java/org/apache/commons/math4/ode/FieldFirstOrderIntegrator.java index 2ab6831..981d22b 100644 --- a/src/main/java/org/apache/commons/math4/ode/FieldFirstOrderIntegrator.java +++ b/src/main/java/org/apache/commons/math4/ode/FieldFirstOrderIntegrator.java @@ -82,7 +82,7 @@ public interface FieldFirstOrderIntegrator<T extends RealFieldElement<T>> { * @param maxIterationCount upper limit of the iteration count in * the event time search events. * @see #addEventHandler(FieldEventHandler, double, double, int, - * org.apache.commons.math4.analysis.solvers.FieldBracketingNthOrderBrentSolver) + * org.apache.commons.math4.analysis.solvers.BracketedRealFieldUnivariateSolver) * @see #getEventHandlers() * @see #clearEventHandlers() */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/FieldODEState.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/FieldODEState.java b/src/main/java/org/apache/commons/math4/ode/FieldODEState.java index de01d97..70132f6 100644 --- a/src/main/java/org/apache/commons/math4/ode/FieldODEState.java +++ b/src/main/java/org/apache/commons/math4/ode/FieldODEState.java @@ -45,7 +45,7 @@ public class FieldODEState<T extends RealFieldElement<T>> { /** Simple constructor. * <p>Calling this constructor is equivalent to call {@link * #FieldODEState(RealFieldElement, RealFieldElement[], RealFieldElement[][]) - * FieldODEState(time, state, null).</p> + * FieldODEState(time, state, null)}.</p> * @param time time * @param state state at time */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/FieldODEStateAndDerivative.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/FieldODEStateAndDerivative.java b/src/main/java/org/apache/commons/math4/ode/FieldODEStateAndDerivative.java index d04aa04..179146a 100644 --- a/src/main/java/org/apache/commons/math4/ode/FieldODEStateAndDerivative.java +++ b/src/main/java/org/apache/commons/math4/ode/FieldODEStateAndDerivative.java @@ -40,7 +40,7 @@ public class FieldODEStateAndDerivative<T extends RealFieldElement<T>> extends F * <p>Calling this constructor is equivalent to call {@link * #FieldODEStateAndDerivative(RealFieldElement, RealFieldElement[], RealFieldElement[], * RealFieldElement[][], RealFieldElement[][]) FieldODEStateAndDerivative(time, state, - * derivative, null, null).</p> + * derivative, null, null)}.</p> * @param time time * @param state state at time * @param derivative derivative of the state at time http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java b/src/main/java/org/apache/commons/math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java index 1ee753a..3cdf2bb 100644 --- a/src/main/java/org/apache/commons/math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java +++ b/src/main/java/org/apache/commons/math4/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java @@ -146,7 +146,7 @@ public abstract class AdaptiveStepsizeFieldIntegrator<T extends RealFieldElement * <p> * A side effect of this method is to also reset the initial * step so it will be automatically computed by the integrator - * if {@link #setInitialStepSize(double) setInitialStepSize} + * if {@link #setInitialStepSize(RealFieldElement) setInitialStepSize} * is not called by the user. * </p> * @param minimalStep minimal step (must be positive even for backward @@ -175,7 +175,7 @@ public abstract class AdaptiveStepsizeFieldIntegrator<T extends RealFieldElement * <p> * A side effect of this method is to also reset the initial * step so it will be automatically computed by the integrator - * if {@link #setInitialStepSize(double) setInitialStepSize} + * if {@link #setInitialStepSize(RealFieldElement) setInitialStepSize} * is not called by the user. * </p> * @param minimalStep minimal step (must be positive even for backward http://git-wip-us.apache.org/repos/asf/commons-math/blob/5672ebe9/src/main/java/org/apache/commons/math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java b/src/main/java/org/apache/commons/math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java index 255b2da..4a786f5 100644 --- a/src/main/java/org/apache/commons/math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java +++ b/src/main/java/org/apache/commons/math4/ode/nonstiff/ThreeEighthesFieldIntegrator.java @@ -41,7 +41,7 @@ import org.apache.commons.math4.util.MathArrays; * * @see EulerFieldIntegrator * @see ClassicalRungeKuttaFieldIntegrator - * @see GillfieldIntegrator + * @see GillFieldIntegrator * @see MidpointFieldIntegrator * @see LutherFieldIntegrator * @param <T> the type of the field elements
