class SimpleRegression extends PredictorMat
The SimpleRegression class supports simple linear regression. In this case,
the vector 'x' consists of the constant one and a single variable 'x1', i.e.,
(1, x1). Fit the parameter vector 'b' in the regression equation
y = b dot x + e = [b0, b1] dot [1, x1] + e = b0 + b1 * x1 + e
where 'e' represents the residuals (the part not explained by the model).
- Alphabetic
- By Inheritance
- SimpleRegression
- PredictorMat
- Error
- Predictor
- Fit
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
SimpleRegression(x: MatriD, y: VectoD)
- x
the input/design matrix augmented with a first column of ones
- y
the response vector
Value Members
-
def
coefficient: VectoD
Return the vector of coefficient/parameter values.
Return the vector of coefficient/parameter values.
- Definition Classes
- Predictor
-
def
crossVal(k: Int = 10): Unit
Perform 'k'-fold cross-validation.
Perform 'k'-fold cross-validation.
- k
the number of folds
- Definition Classes
- SimpleRegression → PredictorMat
-
def
crossValidate(algor: (MatriD, VectoD) ⇒ PredictorMat, k: Int = 10): Array[Statistic]
- Definition Classes
- PredictorMat
-
val
df: (Double, Double)
- Definition Classes
- Fit
-
def
diagnose(e: VectoD, w: VectoD = null, yp: VectoD = null): Unit
Given the error/residual vector, compute the quality of fit measures.
Given the error/residual vector, compute the quality of fit measures.
- e
the corresponding m-dimensional error vector (y - yp)
- w
the weights on the instances
- yp
the predicted response vector (x * b)
- Definition Classes
- Fit
-
def
eval(xx: MatriD, yy: VectoD): Unit
Compute the error and useful diagnostics for the test dataset.
Compute the error and useful diagnostics for the test dataset.
- xx
the test data matrix
- yy
the test response vector
- Definition Classes
- PredictorMat → Predictor
-
def
eval(): Unit
Compute the error and useful diagnostics for the entire dataset.
Compute the error and useful diagnostics for the entire dataset.
- Definition Classes
- PredictorMat → Predictor
-
def
f_(z: Double): String
Format a double value.
-
def
fit: VectoD
Return the quality of fit including 'sst', 'sse', 'mse0', rmse', 'mae', 'rSq', 'df._2', 'rBarSq', 'fStat', 'aic', 'bic'.
Return the quality of fit including 'sst', 'sse', 'mse0', rmse', 'mae', 'rSq', 'df._2', 'rBarSq', 'fStat', 'aic', 'bic'. Note, if 'sse > sst', the model introduces errors and the 'rSq' may be negative, otherwise, R^2 ('rSq') ranges from 0 (weak) to 1 (strong). Note that 'rSq' is the number 5 measure. Override to add more quality of fit measures.
- Definition Classes
- Fit
-
def
fitLabel: Seq[String]
Return the labels for the quality of fit measures.
Return the labels for the quality of fit measures. Override to add more quality of fit measures.
- Definition Classes
- Fit
-
def
fitMap: Map[String, String]
Build a map of quality of fit measures (use of
LinedHashMapmakes it ordered).Build a map of quality of fit measures (use of
LinedHashMapmakes it ordered). Override to add more quality of fit measures.- Definition Classes
- Fit
-
final
def
flaw(method: String, message: String): Unit
- Definition Classes
- Error
-
val
index_rSq: Int
- Definition Classes
- Fit
-
def
mse_: Double
Return the mean of squares for error (sse / df._2).
Return the mean of squares for error (sse / df._2). Must call diagnose first.
- Definition Classes
- Fit
-
def
predict(z: MatriD): VectoD
Predict the value of 'y = f(z)' by evaluating the formula 'y = b dot z', for each row of matrix 'z'.
Predict the value of 'y = f(z)' by evaluating the formula 'y = b dot z', for each row of matrix 'z'.
- z
the new matrix to predict
- Definition Classes
- PredictorMat
-
def
predict(z: VectoD): Double
Predict the value of 'y = f(z)' by evaluating the formula 'y = b dot z', e.g., '(b_0, b_1, b_2) dot (1, z_1, z_2)'.
Predict the value of 'y = f(z)' by evaluating the formula 'y = b dot z', e.g., '(b_0, b_1, b_2) dot (1, z_1, z_2)'.
- z
the new vector to predict
- Definition Classes
- PredictorMat → Predictor
-
def
predict(z: VectoI): Double
Given a new discrete data vector z, predict the y-value of f(z).
Given a new discrete data vector z, predict the y-value of f(z).
- z
the vector to use for prediction
- Definition Classes
- Predictor
-
def
residual: VectoD
Return the vector of residuals/errors.
Return the vector of residuals/errors.
- Definition Classes
- Predictor
-
def
sumCoeff(b: VectoD, stdErr: VectoD = null): String
Produce the summary report portion for the cofficients.
Produce the summary report portion for the cofficients.
- b
the parameters/coefficients for the model
- Definition Classes
- Fit
-
def
summary(): Unit
Compute diagostics for the regression model.
Compute diagostics for the regression model.
- Definition Classes
- PredictorMat
-
def
summary(b: VectoD, stdErr: VectoD = null): String
Produce a summary report with diagnostics for each predictor 'x_j' and the overall quality of fit.
Produce a summary report with diagnostics for each predictor 'x_j' and the overall quality of fit.
- b
the parameters/coefficients for the model
- Definition Classes
- Fit
-
def
train(yy: VectoD = y): SimpleRegression
Train the predictor by fitting the parameter vector (b-vector) in the simple regression equation
Train the predictor by fitting the parameter vector (b-vector) in the simple regression equation
y = b dot x + e = [b0, b1] dot [1, x1] + e
using the least squares method.
- yy
the response vector
- Definition Classes
- SimpleRegression → PredictorMat → Predictor
- See also
www.analyzemath.com/statistics/linear_regression.html
-
def
train(): PredictorMat
Given a set of data vectors 'x's and their corresponding responses 'y's, passed into the implementing class, train the prediction function 'y = f(x)' by fitting its parameters.
Given a set of data vectors 'x's and their corresponding responses 'y's, passed into the implementing class, train the prediction function 'y = f(x)' by fitting its parameters.
- Definition Classes
- PredictorMat