View Javadoc
1   package org.opentrafficsim.kpi.sampling.indicator;
2   
3   import org.djunits.value.vdouble.scalar.base.DoubleScalarRel;
4   
5   /**
6    * Wrapper class for two typed values that represent a confidence interval.
7    * <p>
8    * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
9    * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
10   * </p>
11   * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
12   * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
13   * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
14   * @param <T> type of the values
15   */
16  @Deprecated // non-scalar statistics not yet implemented
17  public class ConfidenceInterval<T extends DoubleScalarRel<?, T>>
18  {
19  
20      /** Lower confidence value. */
21      private final T lowerValue;
22  
23      /** Upper confidence value. */
24      private final T upperValue;
25  
26      /**
27       * Constructor.
28       * @param lowerValue lower confidence value
29       * @param upperValue upper confidence value
30       */
31      public ConfidenceInterval(final T lowerValue, final T upperValue)
32      {
33          this.lowerValue = lowerValue;
34          this.upperValue = upperValue;
35      }
36  
37      /**
38       * Returns lower value.
39       * @return lowerValue.
40       */
41      public T getLowerValue()
42      {
43          return this.lowerValue;
44      }
45  
46      /**
47       * Returns upper value.
48       * @return upperValue.
49       */
50      public T getUpperValue()
51      {
52          return this.upperValue;
53      }
54  
55      @Override
56      public final String toString()
57      {
58          return "ConfidenceInterval [lowerValue=" + this.lowerValue + ", upperValue=" + this.upperValue + "]";
59      }
60  
61  }