Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed javadoc errors. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1454464 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2013-03-08 16:58:10 +00:00
parent fde2416fe3
commit a0086bc16d
6 changed files with 37 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/main/java/org/apache/commons/math3/ExtendedFieldElement.java
View File

@ -97,7 +97,7 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
T rint();
/** Get the closest long to instance value.
* @return closest long to {@link #getValue()}
* @return closest long to {@link #getReal()}
*/
long round();
@ -326,6 +326,7 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @param b Factors.
* @return <code>&Sigma;<sub>i</sub> a<sub>i</sub> b<sub>i</sub></code>.
* @throws DimensionMismatchException if arrays dimensions don't match
* @since 3.2
*/
T linearCombination(double[] a, T[] b)
throws DimensionMismatchException;
@ -352,8 +353,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @param b2 second factor of the second term
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub>
* @see #linearCombination(T, T, T, T, T, T)
* @see #linearCombination(T, T, T, T, T, T, T, T)
* @see #linearCombination(Object, Object, Object, Object, Object, Object)
* @see #linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)
* @since 3.2
*/
T linearCombination(T a1, T b1, T a2, T b2);
@ -380,8 +381,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @param b2 second factor of the second term
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub>
* @see #linearCombination(double, T, double, T, double, T)
* @see #linearCombination(double, T, double, T, double, T, double, T)
* @see #linearCombination(double, Object, double, Object, double, Object)
* @see #linearCombination(double, Object, double, Object, double, Object, double, Object)
* @since 3.2
*/
T linearCombination(double a1, T b1, double a2, T b2);
@ -410,8 +411,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @param b3 second factor of the third term
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub> + a<sub>3</sub>&times;b<sub>3</sub>
* @see #linearCombination(T, T, T, T)
* @see #linearCombination(T, T, T, T, T, T, T, T)
* @see #linearCombination(Object, Object, Object, Object)
* @see #linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)
* @since 3.2
*/
T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3);
@ -440,8 +441,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @param b3 second factor of the third term
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub> + a<sub>3</sub>&times;b<sub>3</sub>
* @see #linearCombination(double, T, double, T)
* @see #linearCombination(double, T, double, T, double, T, double, T)
* @see #linearCombination(double, Object, double, Object)
* @see #linearCombination(double, Object, double, Object, double, Object, double, Object)
* @since 3.2
*/
T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3);
@ -474,8 +475,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub> + a<sub>3</sub>&times;b<sub>3</sub> +
* a<sub>4</sub>&times;b<sub>4</sub>
* @see #linearCombination(T, T, T, T)
* @see #linearCombination(T, T, T, T, T, T)
* @see #linearCombination(Object, Object, Object, Object)
* @see #linearCombination(Object, Object, Object, Object, Object, Object)
* @since 3.2
*/
T linearCombination(T a1, T b1, T a2, T b2, T a3, T b3, T a4, T b4);
@ -508,8 +509,8 @@ public interface ExtendedFieldElement<T> extends FieldElement<T> {
* @return a<sub>1</sub>&times;b<sub>1</sub> +
* a<sub>2</sub>&times;b<sub>2</sub> + a<sub>3</sub>&times;b<sub>3</sub> +
* a<sub>4</sub>&times;b<sub>4</sub>
* @see #linearCombination(double, T, double, T)
* @see #linearCombination(double, T, double, T, double, T)
* @see #linearCombination(double, Object, double, Object)
* @see #linearCombination(double, Object, double, Object, double, Object)
* @since 3.2
*/
T linearCombination(double a1, T b1, double a2, T b2, double a3, T b3, double a4, T b4);

6
src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java
View File

@ -33,7 +33,7 @@ import org.apache.commons.math3.util.MathArrays;
*
* @param <T> the type of the field elements
* @version $Id$
* @see Vector3DDSDS
* @see FieldVector3D
* @see RotationOrder
* @since 3.2
*/
@ -425,7 +425,7 @@ public class FieldRotation<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the normalized axis of the rotation.
* @return normalized axis of the rotation
* @see #Rotation(FieldVector3D, T)
* @see #FieldRotation(FieldVector3D, ExtendedFieldElement)
*/
public FieldVector3D<T> getAxis() {
final T squaredSine = q1.multiply(q1).add(q2.multiply(q2)).add(q3.multiply(q3));
@ -442,7 +442,7 @@ public class FieldRotation<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the angle of the rotation.
* @return angle of the rotation (between 0 and &pi;)
* @see #Rotation(FieldVector3D, T)
* @see #FieldRotation(FieldVector3D, ExtendedFieldElement)
*/
public T getAngle() {
if ((q0.getReal() < -0.1) || (q0.getReal() > 0.1)) {

27
src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java
View File

@ -302,7 +302,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the abscissa of the vector.
* @return abscissa of the vector
* @see #Vector3D(T, T, T)
* @see #FieldVector3D(ExtendedFieldElement, ExtendedFieldElement, ExtendedFieldElement)
*/
public T getX() {
return x;
@ -310,7 +310,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the ordinate of the vector.
* @return ordinate of the vector
* @see #Vector3D(T, T, T)
* @see #FieldVector3D(ExtendedFieldElement, ExtendedFieldElement, ExtendedFieldElement)
*/
public T getY() {
return y;
@ -318,7 +318,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the height of the vector.
* @return height of the vector
* @see #Vector3D(T, T, T)
* @see #FieldVector3D(ExtendedFieldElement, ExtendedFieldElement, ExtendedFieldElement)
*/
public T getZ() {
return z;
@ -326,7 +326,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the vector coordinates as a dimension 3 array.
* @return vector coordinates
* @see #Vector3D(T[])
* @see #FieldVector3D(ExtendedFieldElement[])
*/
public T[] toArray() {
final T[] array = MathArrays.buildArray(x.getField(), 3);
@ -390,7 +390,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the azimuth of the vector.
* @return azimuth (&alpha;) of the vector, between -&pi; and +&pi;
* @see #Vector3D(T, T)
* @see #FieldVector3D(ExtendedFieldElement, ExtendedFieldElement)
*/
public T getAlpha() {
return y.atan2(x);
@ -398,7 +398,7 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/** Get the elevation of the vector.
* @return elevation (&delta;) of the vector, between -&pi;/2 and +&pi;/2
* @see #Vector3D(T, T)
* @see #FieldVector3D(ExtendedFieldElement, ExtendedFieldElement)
*/
public T getDelta() {
return z.divide(getNorm()).asin();
@ -696,14 +696,14 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
/**
* Test for the equality of two 3D vectors.
* <p>
* If all coordinates of two 3D vectors are exactly the same, and none are
* <code>T.NaN</code>, the two 3D vectors are considered to be equal.
* If all coordinates of two 3D vectors are exactly the same, and none of their
* {@link ExtendedFieldElement#getReal() real part} are <code>NaN</code>, the
* two 3D vectors are considered to be equal.
* </p>
* <p>
* <code>NaN</code> coordinates are considered to affect globally the vector
* and be equals to each other - i.e, if either (or all) coordinates of the
* 3D vector are equal to <code>T.NaN</code>, the 3D vector is equal to
* {@link #NaN}.
* and be equals to each other - i.e, if either (or all) real part of the
* coordinates of the 3D vector are <code>NaN</code>, the 3D vector is <code>NaN</code>.
* </p>
*
* @param other Object to test for equality to this
@ -1175,7 +1175,10 @@ public class FieldVector3D<T extends ExtendedFieldElement<T>> implements Seriali
return Vector3DFormat.getInstance().format(toVector3D());
}
/** {@inheritDoc} */
/** Get a string representation of this vector.
* @param format the custom format for components
* @return a string representation of this vector
*/
public String toString(final NumberFormat format) {
return new Vector3DFormat(format).format(toVector3D());
}

5
src/main/java/org/apache/commons/math3/optim/linear/SimplexSolver.java
View File

@ -43,8 +43,9 @@ import org.apache.commons.math3.util.Precision;
* default cut-off value may be too small, thus it is advised to increase it to a larger value,
* in accordance with the chosen epsilon.
* <p>
* It may also be counter-productive to provide a too large value for {@link MaxIter}
* as parameter in the call of {@link #optimize(org.apache.commons.math3.optim.OptimizationData...)},
* It may also be counter-productive to provide a too large value for {@link
* org.apache.commons.math3.optim.MaxIter MaxIter} as parameter in the call of {@link
* #optimize(org.apache.commons.math3.optim.OptimizationData...) optimize(OptimizationData...)},
* as the {@link SimplexSolver} will use different strategies depending on the current iteration
* count. After half of the allowed max iterations has already been reached, the strategy to select
* pivot rows will change in order to break possible cycles due to degenerate problems.

2
src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizer.java
View File

@ -294,7 +294,7 @@ public class NonLinearConjugateGradientOptimizer
* @param optData Optimization data.
* The following data will be looked for:
* <ul>
* <li>{@link InitialStep}</li>
* <li>{@link BracketingStep}</li>
* </ul>
*/
@Override

2
src/main/java/org/apache/commons/math3/optim/nonlinear/vector/JacobianMultivariateVectorOptimizer.java
View File

@ -64,7 +64,7 @@ public abstract class JacobianMultivariateVectorOptimizer
* {@inheritDoc}
*
* @param optData Optimization data. In addition to those documented in
* {@link MultivariateOptimizer#parseOptimizationData(OptimizationData[])
* {@link MultivariateVectorOptimizer#optimize(OptimizationData...)}
* MultivariateOptimizer}, this method will register the following data:
* <ul>
* <li>{@link ModelFunctionJacobian}</li>