various javadoc fixes
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@737161 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe
parent
ead1ffe007
commit
a11930a607
|
|
@ -240,7 +240,7 @@ public class MullerSolver extends UnivariateRealSolverImpl {
|
|||
* @throws FunctionEvaluationException if an error occurs evaluating the
|
||||
* function
|
||||
* @throws IllegalArgumentException if any parameters are invalid
|
||||
* @deprecated replaced by {@link #solve2(UnivariateRealFunction, double, double)
|
||||
* @deprecated replaced by {@link #solve2(UnivariateRealFunction, double, double)}
|
||||
* since 2.0
|
||||
*/
|
||||
@Deprecated
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ public interface UnivariateRealSolver extends ConvergingAlgorithm {
|
|||
* function
|
||||
* @throws IllegalArgumentException if min > max or the endpoints do not
|
||||
* satisfy the requirements specified by the solver
|
||||
* @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double)
|
||||
* @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double)}
|
||||
* since 2.0
|
||||
*/
|
||||
@Deprecated
|
||||
|
|
@ -112,7 +112,7 @@ public interface UnivariateRealSolver extends ConvergingAlgorithm {
|
|||
* function
|
||||
* @throws IllegalArgumentException if min > max or the arguments do not
|
||||
* satisfy the requirements specified by the solver
|
||||
* @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double, double)
|
||||
* @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double, double)}
|
||||
* since 2.0
|
||||
*/
|
||||
@Deprecated
|
||||
|
|
|
|||
|
|
@ -58,7 +58,8 @@ public interface EigenDecomposition extends Serializable {
|
|||
* <p>Real eigenvalues are on the diagonal while complex values are on
|
||||
* 2x2 blocks { {real +imaginary}, {-imaginary, real} }.</p>
|
||||
* @return the D matrix
|
||||
* @see #getEigenValues()
|
||||
* @see #getRealEigenvalues()
|
||||
* @see #getImagEigenvalues()
|
||||
*/
|
||||
RealMatrix getD();
|
||||
|
||||
|
|
|
|||
|
|
@ -38,9 +38,7 @@ import org.apache.commons.math.util.MathUtils;
|
|||
* the upper part of the matrix, the part below the diagonal is not accessed at all.</p>
|
||||
* <p>Eigenvalues are computed as soon as the matrix is decomposed, but eigenvectors
|
||||
* are computed only when required, i.e. only when one of the {@link #getEigenvector(int)},
|
||||
* {@link #getV()}, {@link #getVT()}, {@link #getInverse()}, {@link #solve(double[])},
|
||||
* {@link #solve(RealMatrix)}, {@link #solve(RealVector)} or {@link #solve(RealVectorImpl)}
|
||||
* methods is called.</p>
|
||||
* {@link #getV()}, {@link #getVT()}, {@link #getSolver()} methods is called.</p>
|
||||
* <p>This implementation is based on Inderjit Singh Dhillon thesis
|
||||
* <a href="http://www.cs.utexas.edu/users/inderjit/public_papers/thesis.pdf">A
|
||||
* New O(n<sup>2</sup>) Algorithm for the Symmetric Tridiagonal Eigenvalue/Eigenvector
|
||||
|
|
@ -156,8 +154,6 @@ public class EigenDecompositionImpl implements EigenDecomposition {
|
|||
|
||||
/**
|
||||
* Calculates the eigen decomposition of the given symmetric matrix.
|
||||
* <p>Calling this constructor is equivalent to first call the no-arguments
|
||||
* constructor and then call {@link #decompose(RealMatrix)}.</p>
|
||||
* @param matrix The <strong>symmetric</strong> matrix to decompose.
|
||||
* @param splitTolerance tolerance on the off-diagonal elements relative to the
|
||||
* geometric mean to split the tridiagonal matrix (a suggested value is
|
||||
|
|
@ -182,8 +178,6 @@ public class EigenDecompositionImpl implements EigenDecomposition {
|
|||
|
||||
/**
|
||||
* Calculates the eigen decomposition of the given tridiagonal symmetric matrix.
|
||||
* <p>Calling this constructor is equivalent to first call the no-arguments
|
||||
* constructor and then call {@link #decompose(double[], double[])}.</p>
|
||||
* @param main the main diagonal of the matrix (will be copied)
|
||||
* @param secondary the secondary diagonal of the matrix (will be copied)
|
||||
* @param splitTolerance tolerance on the off-diagonal elements relative to the
|
||||
|
|
@ -348,7 +342,6 @@ public class EigenDecompositionImpl implements EigenDecomposition {
|
|||
/**
|
||||
* Return the determinant of the matrix
|
||||
* @return determinant of the matrix
|
||||
* @see #isNonSingular()
|
||||
*/
|
||||
public double getDeterminant() {
|
||||
double determinant = 1;
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ public interface LUDecomposition extends Serializable {
|
|||
/**
|
||||
* Returns the pivot permutation vector.
|
||||
* @return the pivot permutation vector
|
||||
* @see #getPermutation()
|
||||
* @see #getP()
|
||||
*/
|
||||
int[] getPivot();
|
||||
|
||||
|
|
|
|||
|
|
@ -68,8 +68,6 @@ public class QRDecompositionImpl implements QRDecomposition {
|
|||
|
||||
/**
|
||||
* Calculates the QR-decomposition of the given matrix.
|
||||
* <p>Calling this constructor is equivalent to first call the no-arguments
|
||||
* constructor and then call {@link #decompose(RealMatrix)}.</p>
|
||||
* @param matrix The matrix to decompose.
|
||||
*/
|
||||
public QRDecompositionImpl(RealMatrix matrix) {
|
||||
|
|
|
|||
|
|
@ -80,8 +80,6 @@ public class SingularValueDecompositionImpl implements SingularValueDecompositio
|
|||
|
||||
/**
|
||||
* Calculates the Singular Value Decomposition of the given matrix.
|
||||
* <p>Calling this constructor is equivalent to first call the no-arguments
|
||||
* constructor and then call {@link #decompose(RealMatrix)}.</p>
|
||||
* @param matrix The matrix to decompose.
|
||||
* @exception InvalidMatrixException (wrapping a {@link ConvergenceException}
|
||||
* if algorithm fails to converge
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ public interface ODEIntegrator extends Serializable {
|
|||
* differential equations} problem) if the value of the current step that
|
||||
* is attempted is needed.</p>
|
||||
* <p>The result is undefined if the method is called outside of
|
||||
* calls to {@link #integrate}</p>
|
||||
* calls to <code>integrate</code>.</p>
|
||||
* @return current value of the step start time t<sub>i</sub>
|
||||
*/
|
||||
double getCurrentStepStart();
|
||||
|
|
@ -109,7 +109,7 @@ public interface ODEIntegrator extends Serializable {
|
|||
* differential equations} problem) if the signed value of the current stepsize
|
||||
* that is tried is needed.</p>
|
||||
* <p>The result is undefined if the method is called outside of
|
||||
* calls to {@link #integrate}</p>
|
||||
* calls to <code>integrate</code>.</p>
|
||||
* @return current signed value of the stepsize
|
||||
*/
|
||||
double getCurrentSignedStepsize();
|
||||
|
|
|
|||
|
|
@ -52,7 +52,6 @@ import org.apache.commons.math.ode.sampling.StepHandler;
|
|||
* provided by the {@link AdamsMoultonIntegrator AdamsMoultonIntegrator} class.</p>
|
||||
*
|
||||
* @see AdamsMoultonIntegrator
|
||||
* @see BDFIntegrator
|
||||
* @version $Revision$ $Date$
|
||||
* @since 2.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -52,7 +52,6 @@ import org.apache.commons.math.ode.sampling.StepHandler;
|
|||
* provided by the {@link AdamsBashforthIntegrator AdamsBashforthIntegrator} class.</p>
|
||||
*
|
||||
* @see AdamsBashforthIntegrator
|
||||
* @see BDFIntegrator
|
||||
* @version $Revision$ $Date$
|
||||
* @since 2.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -40,7 +40,6 @@ import org.apache.commons.math.ode.sampling.StepNormalizer;
|
|||
*
|
||||
* @see AdamsBashforthIntegrator
|
||||
* @see AdamsMoultonIntegrator
|
||||
* @see BDFIntegrator
|
||||
* @version $Revision$ $Date$
|
||||
* @since 2.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -59,9 +59,13 @@ public class OLSMultipleLinearRegression extends AbstractMultipleLinearRegressio
|
|||
private QRDecomposition qr = null;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
* Loads model x and y sample data, overriding any previous sample.
|
||||
*
|
||||
* Computes and caches QR decomposition of the X matrix.
|
||||
* @param y the [n,1] array representing the y sample
|
||||
* @param x the [n,k] array representing the x sample
|
||||
* @throws IllegalArgumentException if the x and y array data are not
|
||||
* compatible for the regression
|
||||
*/
|
||||
public void newSampleData(double[] y, double[][] x) {
|
||||
validateSampleData(x, y);
|
||||
|
|
|
|||
Loading…
Reference in New Issue