Javadoc warnings.
This commit is contained in:
parent
de5d148d18
commit
a7de358a05
|
@ -20,7 +20,7 @@ import java.io.Serializable;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This class is a simple container for weighted observed point in
|
* This class is a simple container for weighted observed point in
|
||||||
* {@link CurveFitter curve fitting}.
|
* {@link AbstractCurveFitter curve fitting}.
|
||||||
* <p>Instances of this class are guaranteed to be immutable.</p>
|
* <p>Instances of this class are guaranteed to be immutable.</p>
|
||||||
* @since 2.0
|
* @since 2.0
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -125,7 +125,7 @@ public class PolygonsSet extends AbstractRegion<Euclidean2D, Euclidean1D> {
|
||||||
* <p>This constructor does not handle polygons with a boundary
|
* <p>This constructor does not handle polygons with a boundary
|
||||||
* forming several disconnected paths (such as polygons with holes).</p>
|
* forming several disconnected paths (such as polygons with holes).</p>
|
||||||
* <p>For cases where this simple constructor applies, it is expected to
|
* <p>For cases where this simple constructor applies, it is expected to
|
||||||
* be numerically more robust than the {@link #PolygonsSet(Collection) general
|
* be numerically more robust than the {@link #PolygonsSet(Collection,double) general
|
||||||
* constructor} using {@link SubHyperplane subhyperplanes}.</p>
|
* constructor} using {@link SubHyperplane subhyperplanes}.</p>
|
||||||
* <p>If the list is empty, the region will represent the whole
|
* <p>If the list is empty, the region will represent the whole
|
||||||
* space.</p>
|
* space.</p>
|
||||||
|
@ -186,7 +186,7 @@ public class PolygonsSet extends AbstractRegion<Euclidean2D, Euclidean1D> {
|
||||||
* <p>This constructor does not handle polygons with a boundary
|
* <p>This constructor does not handle polygons with a boundary
|
||||||
* forming several disconnected paths (such as polygons with holes).</p>
|
* forming several disconnected paths (such as polygons with holes).</p>
|
||||||
* <p>For cases where this simple constructor applies, it is expected to
|
* <p>For cases where this simple constructor applies, it is expected to
|
||||||
* be numerically more robust than the {@link #PolygonsSet(Collection) general
|
* be numerically more robust than the {@link #PolygonsSet(Collection,double) general
|
||||||
* constructor} using {@link SubHyperplane subhyperplanes}.</p>
|
* constructor} using {@link SubHyperplane subhyperplanes}.</p>
|
||||||
* @param hyperplaneThickness tolerance below which points are consider to
|
* @param hyperplaneThickness tolerance below which points are consider to
|
||||||
* belong to the hyperplane (which is therefore more a slab)
|
* belong to the hyperplane (which is therefore more a slab)
|
||||||
|
|
|
@ -52,7 +52,7 @@ public class ArrayFieldVector<T extends FieldElement<T>> implements FieldVector<
|
||||||
* Build a 0-length vector.
|
* Build a 0-length vector.
|
||||||
* Zero-length vectors may be used to initialize construction of vectors
|
* Zero-length vectors may be used to initialize construction of vectors
|
||||||
* by data gathering. We start with zero-length and use either the {@link
|
* by data gathering. We start with zero-length and use either the {@link
|
||||||
* #ArrayFieldVector(ArrayFieldVector, ArrayFieldVector)} constructor
|
* #ArrayFieldVector(FieldVector, FieldVector)} constructor
|
||||||
* or one of the {@code append} methods ({@link #add(FieldVector)} or
|
* or one of the {@code append} methods ({@link #add(FieldVector)} or
|
||||||
* {@link #append(ArrayFieldVector)}) to gather data into this vector.
|
* {@link #append(ArrayFieldVector)}) to gather data into this vector.
|
||||||
*
|
*
|
||||||
|
|
|
@ -52,8 +52,7 @@ import org.apache.commons.math4.util.MathUtils;
|
||||||
* user is responsible for converting his bounded point to unbounded by calling
|
* user is responsible for converting his bounded point to unbounded by calling
|
||||||
* {@link #boundedToUnbounded(double[])} before providing them to the optimizer.
|
* {@link #boundedToUnbounded(double[])} before providing them to the optimizer.
|
||||||
* For the same reason, the point returned by the {@link
|
* For the same reason, the point returned by the {@link
|
||||||
* org.apache.commons.math4.optimization.BaseMultivariateOptimizer#optimize(int,
|
* org.apache.commons.math4.optim.BaseMultivariateOptimizer#optimize(OptimizationData[])}
|
||||||
* MultivariateFunction, org.apache.commons.math4.optimization.GoalType, double[])}
|
|
||||||
* method is unbounded. So to convert this point to bounded, users must call
|
* method is unbounded. So to convert this point to bounded, users must call
|
||||||
* {@link #unboundedToBounded(double[])} by themselves!</p>
|
* {@link #unboundedToBounded(double[])} by themselves!</p>
|
||||||
* <p>
|
* <p>
|
||||||
|
|
|
@ -22,7 +22,7 @@ import org.apache.commons.math4.util.FastMath;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Simple implementation of the
|
* Simple implementation of the
|
||||||
* {@link org.apache.commons.math4.optimization.ConvergenceChecker} interface
|
* {@link org.apache.commons.math4.optim.ConvergenceChecker} interface
|
||||||
* that uses only objective function values.
|
* that uses only objective function values.
|
||||||
*
|
*
|
||||||
* Convergence is considered to have been reached if either the relative
|
* Convergence is considered to have been reached if either the relative
|
||||||
|
|
|
@ -347,7 +347,7 @@ public class ValueServer {
|
||||||
/**
|
/**
|
||||||
* Reseeds the random data generator.
|
* Reseeds the random data generator.
|
||||||
*
|
*
|
||||||
* @param seed Value with which to reseed the {@link RandomDataImpl}
|
* @param seed Value with which to reseed the {@link RandomDataGenerator}
|
||||||
* used to generate random data.
|
* used to generate random data.
|
||||||
*/
|
*/
|
||||||
public void reSeed(long seed) {
|
public void reSeed(long seed) {
|
||||||
|
|
Loading…
Reference in New Issue