com.numericalmethod.suanshu.signalprocessing.filter
Enum MovingAverage.Side

java.lang.Object
  java.lang.Enum<MovingAverage.Side>
      com.numericalmethod.suanshu.signalprocessing.filter.MovingAverage.Side

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MovingAverage.Side>

Enclosing class:

MovingAverage

public static enum MovingAverage.Side
extends java.lang.Enum<MovingAverage.Side>

the types of moving average filtering available

Enum Constant Summary

PAST
only past values are used

SYMMETRIC_WINDOW
a symmetric window of past and future values centered around lag 0 are used When a symmetric window is used and the filter length is even, more of the filter is forward in time than backward.

Method Summary

static MovingAverage.Side	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MovingAverage.Side[]	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

SYMMETRIC_WINDOW

public static final MovingAverage.Side SYMMETRIC_WINDOW

a symmetric window of past and future values centered around lag 0 are used

When a symmetric window is used and the filter length is even, more of the filter is forward in time than backward.

PAST

public static final MovingAverage.Side PAST

only past values are used

Method Detail

values

public static MovingAverage.Side[] 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 (MovingAverage.Side c : MovingAverage.Side.values())
    System.out.println(c);

Returns:

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

valueOf

public static MovingAverage.Side 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