SuanShu, a Java numerical and statistical library

com.numericalmethod.suanshu.stats.timeseries.linear.univariate.stationaryprocess.arima.arma
Class ArmaxModel

java.lang.Object
  extended by com.numericalmethod.suanshu.stats.timeseries.linear.univariate.stationaryprocess.arima.ArimaxModel
      extended by com.numericalmethod.suanshu.stats.timeseries.linear.univariate.stationaryprocess.arima.arma.ArmaxModel

public class ArmaxModel
extends ArimaxModel

This class represents a univariate ARMAX (ARMA model with eXogenous inputs) model.

The ARMAX model incorporates exogenous variables and it can be considered as a generalization of the ARMA model. Let Y_t be an ARMAX process, then

Y_t = μ + Σ φ_i * Y_{t-i} + Σ θ_j * ε_{t-j} + ψ * D_t + ε_t,
where D_t is an (m * 1) vector which contains all exogenous variables at time t (excl. the intercept term), and its coefficients are represented by an m-dimensional vector ψ.

See Also:
Wikipedia: Autoregressive moving average model with exogenous inputs model (ARMAX model)

Field Summary
 
Fields inherited from class com.numericalmethod.suanshu.stats.timeseries.linear.univariate.stationaryprocess.arima.ArimaxModel
AR, MA, mu, psi, sigma
 
Constructor Summary
ArmaxModel(ArmaxModel that)
          Copy constructor.
ArmaxModel(double[] AR, double[] MA, double[] psi)
          Construct a zero-intercept (mu) univariate ARMAX model with unit variance.
ArmaxModel(double[] AR, double[] MA, double[] psi, double sigma)
          Construct a zero-intercept (mu) univariate ARMAX model.
ArmaxModel(double mu, double[] AR, double[] MA, double[] psi)
          Construct a univariate ARMAX model with unit variance.
ArmaxModel(double mu, double[] AR, double[] MA, double[] psi, double sigma)
          Construct a univariate ARMAX (ARMA model with eXogenous inputs) model.
 
Method Summary
 double armaxMean(double[] arLags, double[] maLags, double[] exVar)
          Compute the univariate ARMAX conditional mean.
 double armaxMeanNoIntercept(double[] arLags, double[] maLags, double[] exVar)
          Compute the zero-intercept (mu) univariate ARMAX conditional mean.
 
Methods inherited from class com.numericalmethod.suanshu.stats.timeseries.linear.univariate.stationaryprocess.arima.ArimaxModel
AR, AR, d, getArmax, MA, MA, maxPQ, mu, p, psi, q, sigma
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArmaxModel

public ArmaxModel(double mu,
                  double[] AR,
                  double[] MA,
                  double[] psi,
                  double sigma)
Construct a univariate ARMAX (ARMA model with eXogenous inputs) model.

Parameters:
mu - the intercept (constant) term
AR - the AR coefficients (excluding the initial 1); null if no AR coefficient
MA - the MA coefficients (excluding the initial 1); null if no MA coefficient
psi - the coefficients of the deterministic terms (excluding the intercept term)
sigma - the white noise variance

ArmaxModel

public ArmaxModel(double mu,
                  double[] AR,
                  double[] MA,
                  double[] psi)
Construct a univariate ARMAX model with unit variance.

Parameters:
mu - the intercept (constant) term
AR - the AR coefficients (excluding the initial 1); null if no AR coefficient
MA - the MA coefficients (excluding the initial 1); null if no MA coefficient
psi - the coefficients of the deterministic terms (excluding the intercept term)

ArmaxModel

public ArmaxModel(double[] AR,
                  double[] MA,
                  double[] psi,
                  double sigma)
Construct a zero-intercept (mu) univariate ARMAX model.

Parameters:
AR - the AR coefficients (excluding the initial 1); null if no AR coefficient
MA - the MA coefficients (excluding the initial 1); null if no MA coefficient
psi - the coefficients of the deterministic terms (excluding the intercept term)
sigma - the white noise variance

ArmaxModel

public ArmaxModel(double[] AR,
                  double[] MA,
                  double[] psi)
Construct a zero-intercept (mu) univariate ARMAX model with unit variance.

Parameters:
AR - the AR coefficients (excluding the initial 1); null if no AR coefficient
MA - the MA coefficients (excluding the initial 1); null if no MA coefficient
psi - the coefficients of the deterministic terms (excluding the intercept term)

ArmaxModel

public ArmaxModel(ArmaxModel that)
Copy constructor.

Parameters:
that - a univariate ARMAX model
Method Detail

armaxMeanNoIntercept

public double armaxMeanNoIntercept(double[] arLags,
                                   double[] maLags,
                                   double[] exVar)
Compute the zero-intercept (mu) univariate ARMAX conditional mean.

Parameters:
arLags - the AR lags
maLags - the MA lags
exVar - the exogenous variables
Returns:
the conditional mean

armaxMean

public double armaxMean(double[] arLags,
                        double[] maLags,
                        double[] exVar)
Compute the univariate ARMAX conditional mean.

Parameters:
arLags - the AR lags
maLags - the MA lags
exVar - the exogenous variables
Returns:
the conditional mean

SuanShu, a Java numerical and statistical library

Copyright © 2011 Numerical Method Inc. Ltd. All Rights Reserved.