com.github.servicenow.ds.stats.stl

Class LoessSettings

java.lang.Object

com.github.servicenow.ds.stats.stl.LoessSettings

public class LoessSettings
extends java.lang.Object

LoessSettings - immutable settings class for specifying the triple of width/jump/degree used to initialize the LOESS interpolators. Enforces that width be 3 or larger and that the degree is 0 or 1. Created by Jim Crotinger on 12-May-2016.

Constructor Summary

Constructors

Constructor and Description
LoessSettings(int width) Create from width only.
LoessSettings(int width, int degree) Create specifying width and degree, defaulting jump to 10% of smoothing width.
LoessSettings(int width, int degree, int jump) Create specifying width, degree and jump.

Method Summary

Modifier and Type	Method and Description
int	getDegree() Get the degree of the LOESS smoother
int	getJump() Get the jump used between LOESS interpolations.
int	getWidth() Get the width of the LOESS smoother.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoessSettings

public LoessSettings(int width,
                     int degree,
                     int jump)

Create specifying width, degree and jump.

Parameters:

width - int width of the LOESS smoother in data points.

degree - int degree of polynomial used in LOESS.

jump - int number of points to skip between LOESS smoothings.

LoessSettings

public LoessSettings(int width,
                     int degree)

Create specifying width and degree, defaulting jump to 10% of smoothing width.

Parameters:

width - int width of the LOESS smoother in data points.

degree - int degree of polynomial used in LOESS.

LoessSettings

public LoessSettings(int width)

Create from width only. Defaults to linear degree and a jump of 10% of the smoothing width. Enforces minimal width of 3.

Parameters:

width - int width of the LOESS smoother in data points.

Method Detail

getWidth

public final int getWidth()

Get the width of the LOESS smoother.

Returns:

int width of LOESS smoother.

getDegree

public final int getDegree()

Get the degree of the LOESS smoother

Returns:

int degree of the LOESS smoother.

getJump

public final int getJump()

Get the jump used between LOESS interpolations.

Returns:

int jump used between LOESS interpolations.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object