SuanShu, a Java numerical and statistical library

com.numericalmethod.suanshu.stats.timeseries.linear.univariate.sample
Class AutoCorrelation

java.lang.Object
  extended by com.numericalmethod.suanshu.analysis.function.rn2r1.BivariateRealFunction
      extended by com.numericalmethod.suanshu.stats.timeseries.linear.univariate.AutoCorrelationFunction
          extended by com.numericalmethod.suanshu.stats.timeseries.linear.univariate.sample.AutoCorrelation
All Implemented Interfaces:
Function, RealScalarFunction

public class AutoCorrelation
extends AutoCorrelationFunction

This computes the sample Auto-Correlation Function (ACF) for a univariate data set.

See Also:
"William W.S. Wei, "Section 2.5.3. Sample Auto-correlation function" in Time Series Analysis : Univariate and Multivariate Methods (2nd Edition), Addison Wesley; 2 edition (July 17, 2005)"

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.numericalmethod.suanshu.analysis.function.Function
Function.EvaluationException
 
Constructor Summary
AutoCorrelation(TimeSeries xt)
           
AutoCorrelation(TimeSeries xt, AutoCovariance.Type type)
           
 
Method Summary
 double evaluate(double x1, double x2)
          Compute f(x1, x2).
 double evaluate(int k)
          Compute the auto-correlation for lag k.
 
Methods inherited from class com.numericalmethod.suanshu.stats.timeseries.linear.univariate.AutoCorrelationFunction
get
 
Methods inherited from class com.numericalmethod.suanshu.analysis.function.rn2r1.BivariateRealFunction
dimension4Domain, dimension4Range, evaluate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AutoCorrelation

public AutoCorrelation(TimeSeries xt,
                       AutoCovariance.Type type)

AutoCorrelation

public AutoCorrelation(TimeSeries xt)
Method Detail

evaluate

public double evaluate(int k)
Compute the auto-correlation for lag k.

Parameters:
k - lag
Returns:
ρ(k)

evaluate

public double evaluate(double x1,
                       double x2)
Description copied from class: BivariateRealFunction
Compute f(x1, x2).

Specified by:
evaluate in class BivariateRealFunction
Parameters:
x1 - x1
x2 - x2
Returns:
f(x1, x2)

SuanShu, a Java numerical and statistical library

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