Package org.djutils.stats

Enum ConfidenceInterval

java.lang.Object

java.lang.Enum<ConfidenceInterval>

org.djutils.stats.ConfidenceInterval

All Implemented Interfaces:

Serializable, Comparable<ConfidenceInterval>

public enum ConfidenceInterval
extends Enum<ConfidenceInterval>

ConfidenceInterval lists the three type of confidence intervals: two one-sided and one two-sided interval.

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

Author:

Alexander Verbraeck

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH_SIDE_CONFIDENCE	BOTH_SIDE_CONFIDENCE refers to both sides of the confidence.
LEFT_SIDE_CONFIDENCE	LEFT_SIDE_CONFIDENCE refers to the left side confidence.
RIGHT_SIDE_CONFIDENCE	RIGTH_SIDE_CONFIDENCE refers to the right side confidence.

Method Summary

Modifier and Type	Method	Description
static ConfidenceInterval	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConfidenceInterval[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT_SIDE_CONFIDENCE

public static final ConfidenceInterval LEFT_SIDE_CONFIDENCE

LEFT_SIDE_CONFIDENCE refers to the left side confidence.

BOTH_SIDE_CONFIDENCE

public static final ConfidenceInterval BOTH_SIDE_CONFIDENCE

BOTH_SIDE_CONFIDENCE refers to both sides of the confidence.

RIGHT_SIDE_CONFIDENCE

public static final ConfidenceInterval RIGHT_SIDE_CONFIDENCE

RIGTH_SIDE_CONFIDENCE refers to the right side confidence.

Method Detail

values

public static ConfidenceInterval[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfidenceInterval c : ConfidenceInterval.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfidenceInterval valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null