Packages

c

scalation.analytics

TranRegression

class TranRegression extends Predictor with Error

The TranRegression class supports transformed multiple linear regression. In this case, 'x' is multi-dimensional [1, x_1, ... x_k]. Fit the parameter vector 'b' in the transformed regression equation

transform (y) = b dot x + e = b_0 + b_1 * x_1 + b_2 * x_2 ... b_k * x_k + e

where 'e' represents the residuals (the part not explained by the model) and 'transform' is the function (defaults to log) used to transform the response vector 'y'. Common transforms: log (y), sqrt (y) when y > 0 More generally, a Box-Cox Transformation may be applied.

See also

www.ams.sunysb.edu/~zhu/ams57213/Team3.pptx

citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.469.7176&rep=rep1&type=pdf Use Least-Squares (minimizing the residuals) to fit the parameter vector b = x_pinv * y where 'x_pinv' is the pseudo-inverse. Caveat: this class does not provide transformations on columns of matrix 'x'.

Linear Supertypes
Error, Predictor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TranRegression
  2. Error
  3. Predictor
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TranRegression(x: MatrixD, y: VectorD, transform: FunctionS2S = log, technique: RegTechnique = QR)

    x

    the design/data matrix

    y

    the response vector

    transform

    the transformation function (defaults to log)

    technique

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val b: VectoD
    Attributes
    protected
    Definition Classes
    Predictor
  6. def backElim(): (Int, VectoD, VectorD)

    Perform backward elimination to remove the least predictive variable from the model, returning the variable to eliminate, the new parameter vector, the new R-squared value and the new F statistic.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def coefficient: VectoD

    Return the vector of coefficient/parameter values.

    Return the vector of coefficient/parameter values.

    Definition Classes
    Predictor
  9. def diagnose(yy: VectoD): Unit

    Compute diagostics for the predictor.

    Compute diagostics for the predictor. Override to add more diagostics. Note, for 'rmse', 'sse' is divided by the number of instances 'm' rather than degrees of freedom.

    yy

    the response vector

    Definition Classes
    Predictor
    See also

    en.wikipedia.org/wiki/Mean_squared_error

  10. val e: VectoD
    Attributes
    protected
    Definition Classes
    Predictor
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def fit: VectorD

    Return the quality of fit.

    Return the quality of fit.

    Definition Classes
    TranRegressionPredictor
  15. def fitLabels: Seq[String]

    Return the labels for the fit.

    Return the labels for the fit.

    Definition Classes
    TranRegressionPredictor
  16. final def flaw(method: String, message: String): Unit
    Definition Classes
    Error
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val mae: Double
    Attributes
    protected
    Definition Classes
    Predictor
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  24. 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
    TranRegressionPredictor
  25. 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
  26. val rSq: Double
    Attributes
    protected
    Definition Classes
    Predictor
  27. def residual: VectoD

    Return the vector of residuals/errors.

    Return the vector of residuals/errors.

    Definition Classes
    TranRegressionPredictor
  28. val rg: Regression[MatrixD, VectorD]
  29. val rmse: Double
    Attributes
    protected
    Definition Classes
    Predictor
  30. val sse: Double
    Attributes
    protected
    Definition Classes
    Predictor
  31. val ssr: Double
    Attributes
    protected
    Definition Classes
    Predictor
  32. val sst: Double
    Attributes
    protected
    Definition Classes
    Predictor
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. def train(): Unit

    Train the predictor by fitting the parameter vector (b-vector) in the regression equation on 'yt'.

    Train the predictor by fitting the parameter vector (b-vector) in the regression equation on 'yt'.

    Definition Classes
    TranRegressionPredictor
  36. def train(yy: VectoD): Unit

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

    Retrain 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_2 ... x_k] + e

    using the least squares method.

    yy

    the response vector

    Definition Classes
    TranRegressionPredictor
  37. def vif: VectorD

    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.

  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. val yt: VectorD

Inherited from Error

Inherited from Predictor

Inherited from AnyRef

Inherited from Any

Ungrouped