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 2015/12/10 15:15:52 UTC
[4/5] [math] Fixed javadoc.
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/d4b24804
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/d4b24804
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/d4b24804
Branch: refs/heads/MATH_3_X
Commit: d4b24804d1a202ade34cd5a66f94b3eded2b2242
Parents: 56eb5b5
Author: Luc Maisonobe <lu...@apache.org>
Authored: Thu Dec 10 14:52:28 2015 +0100
Committer: Luc Maisonobe <lu...@apache.org>
Committed: Thu Dec 10 14:59:49 2015 +0100
----------------------------------------------------------------------
.../commons/math3/analysis/RealFieldUnivariateFunction.java | 2 +-
.../apache/commons/math3/ode/AbstractFieldIntegrator.java | 4 ++--
.../commons/math3/ode/ContinuousOutputFieldModel.java | 9 ++++-----
.../apache/commons/math3/ode/FieldFirstOrderIntegrator.java | 2 +-
.../commons/math3/ode/FieldODEStateAndDerivative.java | 2 +-
.../math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java | 4 ++--
.../math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java | 2 +-
7 files changed, 12 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-math/blob/d4b24804/src/main/java/org/apache/commons/math3/analysis/RealFieldUnivariateFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/RealFieldUnivariateFunction.java b/src/main/java/org/apache/commons/math3/analysis/RealFieldUnivariateFunction.java
index 21d7fa0..0c6d8a2 100644
--- a/src/main/java/org/apache/commons/math3/analysis/RealFieldUnivariateFunction.java
+++ b/src/main/java/org/apache/commons/math3/analysis/RealFieldUnivariateFunction.java
@@ -22,7 +22,7 @@ import org.apache.commons.math3.RealFieldElement;
* An interface representing a univariate real function.
* <br/>
* When a <em>user-defined</em> function encounters an error during
- * evaluation, the {@link #value(FieldElement) value} method should throw a
+ * evaluation, the {@link #value(RealFieldElement) value} method should throw a
* <em>user-defined</em> unchecked exception.
* <br/>
* The following code excerpt shows the recommended way to do that using
http://git-wip-us.apache.org/repos/asf/commons-math/blob/d4b24804/src/main/java/org/apache/commons/math3/ode/AbstractFieldIntegrator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/AbstractFieldIntegrator.java b/src/main/java/org/apache/commons/math3/ode/AbstractFieldIntegrator.java
index 481f874..e848e0f 100644
--- a/src/main/java/org/apache/commons/math3/ode/AbstractFieldIntegrator.java
+++ b/src/main/java/org/apache/commons/math3/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/d4b24804/src/main/java/org/apache/commons/math3/ode/ContinuousOutputFieldModel.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/ContinuousOutputFieldModel.java b/src/main/java/org/apache/commons/math3/ode/ContinuousOutputFieldModel.java
index 006249b..496d0e2 100644
--- a/src/main/java/org/apache/commons/math3/ode/ContinuousOutputFieldModel.java
+++ b/src/main/java/org/apache/commons/math3/ode/ContinuousOutputFieldModel.java
@@ -38,11 +38,10 @@ import org.apache.commons.math3.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/d4b24804/src/main/java/org/apache/commons/math3/ode/FieldFirstOrderIntegrator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/FieldFirstOrderIntegrator.java b/src/main/java/org/apache/commons/math3/ode/FieldFirstOrderIntegrator.java
index 24c0f1f..ae6d8c0 100644
--- a/src/main/java/org/apache/commons/math3/ode/FieldFirstOrderIntegrator.java
+++ b/src/main/java/org/apache/commons/math3/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.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver)
+ * org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)
* @see #getEventHandlers()
* @see #clearEventHandlers()
*/
http://git-wip-us.apache.org/repos/asf/commons-math/blob/d4b24804/src/main/java/org/apache/commons/math3/ode/FieldODEStateAndDerivative.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/FieldODEStateAndDerivative.java b/src/main/java/org/apache/commons/math3/ode/FieldODEStateAndDerivative.java
index 9c20fb6..79f192b 100644
--- a/src/main/java/org/apache/commons/math3/ode/FieldODEStateAndDerivative.java
+++ b/src/main/java/org/apache/commons/math3/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/d4b24804/src/main/java/org/apache/commons/math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java b/src/main/java/org/apache/commons/math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java
index e928e3b..49e00f3 100644
--- a/src/main/java/org/apache/commons/math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.java
+++ b/src/main/java/org/apache/commons/math3/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/d4b24804/src/main/java/org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java b/src/main/java/org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java
index e251b79..26691c7 100644
--- a/src/main/java/org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java
+++ b/src/main/java/org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.java
@@ -41,7 +41,7 @@ import org.apache.commons.math3.util.MathArrays;
*
* @see EulerFieldIntegrator
* @see ClassicalRungeKuttaFieldIntegrator
- * @see GillfieldIntegrator
+ * @see GillFieldIntegrator
* @see MidpointFieldIntegrator
* @see LutherFieldIntegrator
* @param <T> the type of the field elements