org.opentrafficsim.kpi.sampling.indicator

Class Persistent<U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<U,T>,W extends Number>

java.lang.Object

org.opentrafficsim.kpi.sampling.indicator.Persistent<U,T,W>

Type Parameters:

U - unit of the value

T - class of the value

W - weight class

All Implemented Interfaces:

org.djunits.value.vdouble.scalar.DoubleScalarInterface

public final class Persistent<U extends org.djunits.unit.Unit<U>,T extends org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<U,T>,W extends Number>
extends Object
implements org.djunits.value.vdouble.scalar.DoubleScalarInterface

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 17 okt. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
Persistent(U unit) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addValue(T value, W weight) Adds a value with given weight to the persistent.
Persistent<U,T,W>	copy() Creates a copy.
ConfidenceInterval<T>	getConfidenceInterval(double alpha)
ConfidenceInterval<T>	getConfidenceInterval(double alpha, IntervalSide side)
double	getInUnit()
T	getMax()
T	getMean()
T	getMin()
long	getN()
double	getSI()
T	getStDev()
T	getSum()
double	getVariance()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Persistent

public Persistent(U unit)

Constructor.

Parameters:

unit - unit, does't matter which one, so long it belongs to the right quantity

Method Detail

copy

public Persistent<U,T,W> copy()

Creates a copy.

Returns:

a copy

addValue

public void addValue(T value,
                     W weight)

Adds a value with given weight to the persistent.

Parameters:

value -

weight -

getConfidenceInterval

public ConfidenceInterval<T> getConfidenceInterval(double alpha)

Parameters:

alpha - confidence level

Returns:

both-side confidence interval

getConfidenceInterval

public ConfidenceInterval<T> getConfidenceInterval(double alpha,
                                                   IntervalSide side)

Parameters:

alpha - confidence level

side - side of confidence interval

Returns:

confidence interval

getMin

public T getMin()

Returns:

min value

getMax

public T getMax()

Returns:

max value

getN

public long getN()

Returns:

number of measurments

getMean

public T getMean()

Returns:

mean value

getSI

public double getSI()

Specified by:

getSI in interface org.djunits.value.vdouble.scalar.DoubleScalarInterface

getInUnit

public double getInUnit()

Specified by:

getInUnit in interface org.djunits.value.vdouble.scalar.DoubleScalarInterface

getVariance

public double getVariance()

Returns:

variance in si

getStDev

public T getStDev()

Returns:

standard deviation

getSum

public T getSum()

Returns:

sum