SinusoidalSeries (StochasticPetriNets)

java.lang.Object
- org.apache.commons.math3.distribution.AbstractRealDistribution
- - org.processmining.plugins.stochasticpetrinet.distribution.AnotherAbstractRealDistribution
  - - org.processmining.plugins.stochasticpetrinet.distribution.timeseries.StatefulTimeseriesDistribution
    - - org.processmining.plugins.stochasticpetrinet.distribution.timeseries.SinusoidalSeries

All Implemented Interfaces:

java.io.Serializable, org.apache.commons.math3.analysis.UnivariateFunction, org.apache.commons.math3.distribution.RealDistribution
```
public class SinusoidalSeries
extends StatefulTimeseriesDistribution
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class org.processmining.plugins.stochasticpetrinet.distribution.timeseries.StatefulTimeseriesDistribution
  noiseDistribution, onlyPositive
- Fields inherited from class org.processmining.plugins.stochasticpetrinet.distribution.AnotherAbstractRealDistribution
  cachedMean, cachedVariance
- Fields inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
  random, randomData, SOLVER_DEFAULT_ABSOLUTE_ACCURACY

Constructor Summary

Constructors
Constructor	Description
`SinusoidalSeries(double amplitude)`
`SinusoidalSeries(double amplitude, double period)`
`SinusoidalSeries(double amplitude, double period, double origin)`
`SinusoidalSeries(double amplitude, double period, double origin, double noise)`	A sinusoidal sequence that obviously has seasonal behavior

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

protected double getCurrentSeriesValue(long currentTime)
Sub-classes need to implement this.
- Methods inherited from class org.processmining.plugins.stochasticpetrinet.distribution.timeseries.StatefulTimeseriesDistribution
  cumulativeProbability, density, getSupportLowerBound, getSupportUpperBound, isSupportConnected, isSupportLowerBoundInclusive, isSupportUpperBoundInclusive, sample, sample, setCurrentTime
- Methods inherited from class org.processmining.plugins.stochasticpetrinet.distribution.AnotherAbstractRealDistribution
  getNumericalMean, getNumericalVariance, value
- Methods inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
  cumulativeProbability, getSolverAbsoluteAccuracy, inverseCumulativeProbability, logDensity, probability, probability, reseedRandomGenerator, sample
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SinusoidalSeries
```
public SinusoidalSeries(double amplitude)
```
  - SinusoidalSeries
```
public SinusoidalSeries(double amplitude,
                        double period)
```
  - SinusoidalSeries
```
public SinusoidalSeries(double amplitude,
                        double period,
                        double origin)
```
  - SinusoidalSeries
```
public SinusoidalSeries(double amplitude,
                        double period,
                        double origin,
                        double noise)
```
    A sinusoidal sequence that obviously has seasonal behavior
    
    Parameters:
    
    amplitude - the amplitude of the sinus wave
    
    period - the period of the season in days
    
    origin -
- Method Detail
  - getCurrentSeriesValue
```
protected double getCurrentSeriesValue(long currentTime)
```
    Description copied from class: StatefulTimeseriesDistribution
    
    Sub-classes need to implement this. It returns the value of the time series model given the current time
    
    Specified by:
    
    getCurrentSeriesValue in class StatefulTimeseriesDistribution
    
    Parameters:
    
    currentTime - the current time as a POSIX timestamp (millis since 01-01-1970)
    
    Returns:
    
    double the value of the underlying series at the given point in time.