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

added missing @since tags 

JIRA: MATH-529

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/branches/MATH_2_X@1073459 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2011-02-22 19:18:12 +00:00
parent 34616efd4c
commit 816b795371
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java
View File

@ -44,6 +44,7 @@ public abstract class AbstractMultipleLinearRegression implements
/** /**
* @return true if the model has no intercept term; false otherwise * @return true if the model has no intercept term; false otherwise
* @since 2.2
*/ */
public boolean isNoIntercept() { public boolean isNoIntercept() {
return noIntercept; return noIntercept;
@ -51,6 +52,7 @@ public abstract class AbstractMultipleLinearRegression implements
/** /**
* @param noIntercept true means the model is to be estimated without an intercept term * @param noIntercept true means the model is to be estimated without an intercept term
* @since 2.2
*/ */
public void setNoIntercept(boolean noIntercept) { public void setNoIntercept(boolean noIntercept) {
this.noIntercept = noIntercept; this.noIntercept = noIntercept;
@ -287,6 +289,7 @@ public abstract class AbstractMultipleLinearRegression implements
* Estimates the variance of the error. * Estimates the variance of the error.
* *
* @return estimate of the error variance * @return estimate of the error variance
* @since 2.2
*/ */
public double estimateErrorVariance() { public double estimateErrorVariance() {
return calculateErrorVariance(); return calculateErrorVariance();
@ -297,6 +300,7 @@ public abstract class AbstractMultipleLinearRegression implements
* Estimates the standard error of the regression. * Estimates the standard error of the regression.
* *
* @return regression standard error * @return regression standard error
* @since 2.2
*/ */
public double estimateRegressionStandardError() { public double estimateRegressionStandardError() {
return Math.sqrt(estimateErrorVariance()); return Math.sqrt(estimateErrorVariance());
@ -336,6 +340,7 @@ public abstract class AbstractMultipleLinearRegression implements
* matrix X. * matrix X.
* *
* @return error variance estimate * @return error variance estimate
* @since 2.2
*/ */
protected double calculateErrorVariance() { protected double calculateErrorVariance() {
RealVector residuals = calculateResiduals(); RealVector residuals = calculateResiduals();