nl.liacs.timeseries.kernel

Class AbstractKernel

java.lang.Object

nl.liacs.timeseries.kernel.AbstractKernel

Direct Known Subclasses:

ContinuousKernel, DiscreteKernel

public abstract class AbstractKernel
extends java.lang.Object

AbstractKernel is the super class of all kernels. However, no concrete kernel implementations should extend the abstract class AbstractKernel directly.

ContinousKernel is the super class of all continuous kernels. All continuous kernels should extend ContinuousKernel.

DiscreteKernel is the super class of all discrete kernels. All discrete kernels should extend DiscreteKernel.

Author:

Marvin Meeng Last updated 11.07.2012

See Also:

ContinuousKernel, DiscreteKernel

Constructor Summary

Constructors

Constructor and Description
AbstractKernel()

Method Summary

Methods

Modifier and Type	Method and Description
abstract double[]	applyTo(double[] theArray) Deprecated.
abstract double[]	applyTo(double[] theArray, int theDelay) Apply the kernel to the specified array, with the specified delay.
abstract java.lang.String	getGuiText() Deprecated.
abstract boolean	getHasDelay() Deprecated.
abstract boolean	getHasOOBP() Deprecated.
abstract boolean	getHasWidth() Deprecated.
abstract int	getNrExtraFields() Deprecated.
abstract java.lang.String	getShortText() Deprecated.
abstract java.lang.String	toString() Returns the String representation of the kernel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractKernel

public AbstractKernel()

Method Detail

applyTo

@Deprecated
public abstract double[] applyTo(double[] theArray)

Deprecated.

Apply the kernel to the specified array, with the specified delay.

In general, for kernels for which getHasWidth() returns true, the application of the kernel to the head and tail of the input array is undefined. This method will fill in the values for which this condition applies by using the OutOfBoundsPolicy set for the kernel.

Parameters:

theArray - The array to apply the kernel to.

Returns:

A new double[] with the result.

applyTo

public abstract double[] applyTo(double[] theArray,
               int theDelay)

Apply the kernel to the specified array, with the specified delay.

The delay may be 0, positive or negative. For a delay of 0 the values in the return array map directly to the input array. For a positive delay of n the values in the input array are 'shifted' n indices to the right. For a negative delay this 'shift' is to the left.

In general, for kernels for which getHasWidth() returns true, the application of the kernel to the head and tail of the input array is undefined. This method will fill in the values for which this condition applies by using the OutOfBoundsPolicy set for the kernel.

Parameters:

theArray - The array to apply the kernel to.

theDelay - The delay to use.

Returns:

A new double[] with the result.

getGuiText

@Deprecated
public abstract java.lang.String getGuiText()

Deprecated.

Returns the GUI friendly text for the kernel.

For most kernels this method returns the same result as a call to kernel.class.getSimpleName(). For some, the returned String will include some white spaces that beak up the various words, such that it forms regular text.

Returns:

A GUI friendly String.

getShortText

@Deprecated
public abstract java.lang.String getShortText()

Deprecated.

Returns the short text for the kernel.

Returns:

A short String indicative of the class name.

getHasWidth

@Deprecated
public abstract boolean getHasWidth()

Deprecated.

Returns whether the kernel has a width.

This is true for a DiscreteKernel, and false for a ContinuousKernel.

Returns:

true iff the kernel has a width, false otherwise.

See Also:

ContinuousKernel, DiscreteKernel

getHasOOBP

@Deprecated
public abstract boolean getHasOOBP()

Deprecated.

Returns whether the kernel has an OutOfBoundsPolicy.

This is true for a DiscreteKernel, and false for a ContinuousKernel.

Returns:

true iff the kernel has an out of bounds policy, false otherwise.

See Also:

OutOfBoundsPolicy, ContinuousKernel, DiscreteKernel

getHasDelay

@Deprecated
public abstract boolean getHasDelay()

Deprecated.

Returns whether a delay can be set for the kernel.

This is true for almost all kernels, but not for MovingAverage.

Returns:

true iff a delay can be set for the kernel, false otherwise.

getNrExtraFields

@Deprecated
public abstract int getNrExtraFields()

Deprecated.

Returns the number of extra fields for the kernel.

Extra fields hold kernel specific configuration settings, not shared with other kernels.

Returns:

The number of extra fields.

toString

public abstract java.lang.String toString()

Returns the String representation of the kernel.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the kernel.