org.opentrafficsim.kpi.sampling.indicator.ConfidenceInterval Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ots-kpi Show documentation

OpenTrafficSim KPI Module without dependencies to ots-road or ots-core

There is a newer version: 1.7.5

package org.opentrafficsim.kpi.sampling.indicator;

import org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel;

/**
 * Wrapper class for two typed values that represent a confidence interval.
 * 
 * Copyright (c) 2013-2023 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. 

 * BSD-style license. See OpenTrafficSim License.
 * 
 * @author Alexander Verbraeck
 * @author Peter Knoppers
 * @author Wouter Schakel
 * @param  type of the values
 */
public class ConfidenceInterval>
{

    /** Lower confidence value. */
    private final T lowerValue;

    /** Upper confidence value. */
    private final T upperValue;

    /**
     * @param lowerValue T; lower confidence value
     * @param upperValue T; upper confidence value
     */
    ConfidenceInterval(final T lowerValue, final T upperValue)
    {
        this.lowerValue = lowerValue;
        this.upperValue = upperValue;
    }

    /**
     * @return lowerValue.
     */
    public T getLowerValue()
    {
        return this.lowerValue;
    }

    /**
     * @return upperValue.
     */
    public T getUpperValue()
    {
        return this.upperValue;
    }

    /** {@inheritDoc} */
    @Override
    public final String toString()
    {
        return "ConfidenceInterval [lowerValue=" + this.lowerValue + ", upperValue=" + this.upperValue + "]";
    }

}