Packages

class ResponseSurface extends Regression

The ResponseSurface class uses multiple regression to fit a quadratic/cubic surface to the data. For example in 2D, the quadratic regression equation is

y = b dot x + e = [b_0, ... b_k] dot [1, x_0, x_02, x_1, x_0*x_1, x_12] + e

See also

scalation.metamodel.QuadraticFit

Linear Supertypes
Regression, PredictorMat, Error, Predictor, Fit, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResponseSurface
  2. Regression
  3. PredictorMat
  4. Error
  5. Predictor
  6. Fit
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ResponseSurface(x_: MatriD, y: VectoD, cubic: Boolean = false, technique: RegTechnique = QR)

    x_

    the input vectors/points

    y

    the response vector

    cubic

    the order of the surface (defaults to quadratic, else cubic)

    technique

    the technique used to solve for b in x.t*x*b = x.t*y

Type Members

  1. type Fac_QR = Fac_QR_H[MatriD]
    Definition Classes
    Regression

Value Members

  1. def backwardElim(cols: Set[Int]): (Int, VectoD, VectoD)

    Perform backward elimination to remove the least predictive variable from the existing model, returning the variable to eliminate, the new parameter vector and the new quality of fit.

    Perform backward elimination to remove the least predictive variable from the existing model, returning the variable to eliminate, the new parameter vector and the new quality of fit. May be called repeatedly.

    cols

    the columns of matrix x included in the existing model

    Definition Classes
    Regression
  2. def coefficient: VectoD

    Return the vector of coefficient/parameter values.

    Return the vector of coefficient/parameter values.

    Definition Classes
    Predictor
  3. def crossVal(k: Int = 10): Unit

    Perform 'k'-fold cross-validation.

    Perform 'k'-fold cross-validation.

    k

    the number of folds

    Definition Classes
    ResponseSurfaceRegressionPredictorMat
  4. def crossValidate(algor: (MatriD, VectoD) ⇒ PredictorMat, k: Int = 10): Array[Statistic]
    Definition Classes
    PredictorMat
  5. val df: (Double, Double)
    Definition Classes
    Fit
  6. 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
  7. 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
    PredictorMatPredictor
  8. 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
    PredictorMatPredictor
  9. def f_(z: Double): String

    Format a double value.

    Format a double value.

    z

    the double value to format

    Definition Classes
    Fit
  10. 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
  11. 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
  12. def fitMap: Map[String, String]

    Build a map of quality of fit measures (use of LinedHashMap makes it ordered).

    Build a map of quality of fit measures (use of LinedHashMap makes it ordered). Override to add more quality of fit measures.

    Definition Classes
    Fit
  13. final def flaw(method: String, message: String): Unit
    Definition Classes
    Error
  14. def forwardSel(cols: Set[Int]): (Int, VectoD, VectoD)

    Perform forward selection to add the most predictive variable to the existing model, returning the variable to add, the new parameter vector and the new quality of fit.

    Perform forward selection to add the most predictive variable to the existing model, returning the variable to add, the new parameter vector and the new quality of fit. May be called repeatedly.

    cols

    the columns of matrix x included in the existing model

    Definition Classes
    Regression
  15. val index_rSq: Int
    Definition Classes
    Fit
  16. 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
  17. def predict(z: VectoD): Double

    Given a point 'z', use the quadratic 'rsm' regression equation to predict a value for the function at 'z'.

    Given a point 'z', use the quadratic 'rsm' regression equation to predict a value for the function at 'z'. for 1D: b_0 + b_1*z_0 + b_2*z_02 for 2D: b_0 + b_1*z_0 + b_2*z_02 + b_3*z_1 + b_4*z_1*z_0 + b_5*z_1^2

    z

    the point/vector whose functional value is to be predicted

    Definition Classes
    ResponseSurfacePredictorMatPredictor
  18. 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
  19. 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
  20. def residual: VectoD

    Return the vector of residuals/errors.

    Return the vector of residuals/errors.

    Definition Classes
    Predictor
  21. 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
  22. def summary(): Unit

    Compute diagostics for the regression model.

    Compute diagostics for the regression model.

    Definition Classes
    PredictorMat
  23. 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
  24. def train(yy: VectoD = y): Regression

    Train the predictor by fitting the parameter vector (b-vector) in the multiple regression equation

    Train the predictor by fitting the parameter vector (b-vector) in the multiple regression equation

    yy = b dot x + e = [b_0, ... b_k] dot [1, x_1 , ... x_k] + e

    using the ordinary least squares 'OLS' method.

    yy

    the response vector to work with (defaults to y)

    Definition Classes
    RegressionPredictorMatPredictor
  25. 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
  26. def vif: VectoD

    Compute the Variance Inflation Factor 'VIF' for each variable to test for multi-collinearity by regressing 'xj' against the rest of the variables.

    Compute the Variance Inflation Factor 'VIF' for each variable to test for multi-collinearity by regressing 'xj' against the rest of the variables. A VIF over 10 indicates that over 90% of the variance of 'xj' can be predicted from the other variables, so 'xj' is a candidate for removal from the model.

    Definition Classes
    Regression