SuanShu, a Java numerical and statistical library

com.numericalmethod.suanshu.stats.timeseries.linear.univariate.sample
Enum AutoCovariance.Type

java.lang.Object
  extended by java.lang.Enum<AutoCovariance.Type>
      extended by com.numericalmethod.suanshu.stats.timeseries.linear.univariate.sample.AutoCovariance.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AutoCovariance.Type>
Enclosing class:
AutoCovariance

public static enum AutoCovariance.Type
extends java.lang.Enum<AutoCovariance.Type>


Enum Constant Summary
TYPE_I
          default: the denominator is the time series length
TYPE_II
          the denominator is the time series length minus the lag
 
Method Summary
static AutoCovariance.Type valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AutoCovariance.Type[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TYPE_I

public static final AutoCovariance.Type TYPE_I
default: the denominator is the time series length


TYPE_II

public static final AutoCovariance.Type TYPE_II
the denominator is the time series length minus the lag

Method Detail

values

public static AutoCovariance.Type[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AutoCovariance.Type c : AutoCovariance.Type.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AutoCovariance.Type valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

SuanShu, a Java numerical and statistical library

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