Author: luc
Date: Sun Jan 20 10:04:48 2008
New Revision: 613637
URL: http://svn.apache.org/viewvc?rev=613637&view=rev
Log:
fixed missing javadoc tags
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -86,6 +86,8 @@
* </pre><p>
* The computational complexity is O(N^2).
*
+ * @param x the interpolating points array
+ * @param y the interpolating values array
* @return a fresh copy of the divided difference array
* @throws DuplicateSampleAbscissaException if any abscissas coincide
*/
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
Sun Jan 20 10:04:48 2008
@@ -276,6 +276,8 @@
* The interpolating points must be distinct. However it is not
* verified here, it is checked in evaluate() and computeCoefficients().
*
+ * @param x the interpolating points array
+ * @param y the interpolating values array
* @throws IllegalArgumentException if not valid
* @see #evaluate(double[], double[], double)
* @see #computeCoefficients()
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
Sun Jan 20 10:04:48 2008
@@ -196,6 +196,8 @@
* The centers must be distinct for interpolation purposes, but not
* for general use. Thus it is not verified here.
*
+ * @param a the coefficients in Newton form formula
+ * @param c the centers
* @throws IllegalArgumentException if not valid
* @see DividedDifferenceInterpolator#computeDividedDifference(double[],
* double[])
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
Sun Jan 20 10:04:48 2008
@@ -284,6 +284,7 @@
* other.</p>
* @param v1 first vector
* @param v2 second vector
+ * @return angular separation between v1 and v2
* @exception ArithmeticException if either vector has a null norm
*/
public static double angle(Vector3D v1, Vector3D v2) {
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
Sun Jan 20 10:04:48 2008
@@ -381,7 +381,7 @@
/***
* Sets the rounding mode for decimal divisions.
* @see BigDecimal
- * @param roundingMode
+ * @param roundingMode rounding mode for decimal divisions
*/
public void setRoundingMode(int roundingMode) {
this.roundingMode = roundingMode;
@@ -400,7 +400,7 @@
/***
* Sets the scale for division operations.
* @see BigDecimal
- * @param scale
+ * @param scale scale for division operations
*/
public void setScale(int scale) {
this.scale = scale;
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -186,6 +186,7 @@
* step has been finalized. It must perform a deep copy
* to have an new instance completely independent for the
* original instance.
+ * @return a copy of the finalized instance
*/
protected abstract StepInterpolator doCopy();
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -69,6 +69,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new ClassicalRungeKuttaStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -78,6 +78,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new DormandPrince54StepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -89,6 +89,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new DormandPrince853StepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -71,6 +71,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new DummyStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -62,6 +62,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new EulerStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -67,6 +67,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new GillStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -220,6 +220,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new GraggBulirschStoerStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -53,6 +53,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new HighamHall54StepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -64,6 +64,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new MidpointStepInterpolator(this);
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java?rev=613637&r1=613636&r2=613637&view=diff
==============================================================================
---
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java
(original)
+++
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java
Sun Jan 20 10:04:48 2008
@@ -69,6 +69,7 @@
}
/** Really copy the finalized instance.
+ * @return a copy of the finalized instance
*/
protected StepInterpolator doCopy() {
return new ThreeEighthesStepInterpolator(this);
