Package org.hipparchus.stat.interval

Class ConfidenceInterval

java.lang.Object

org.hipparchus.stat.interval.ConfidenceInterval

public class ConfidenceInterval
extends Object

Represents an interval estimate of a population parameter.

Constructor Summary

Constructors

Constructor	Description
ConfidenceInterval(double lowerBound, double upperBound, double confidenceLevel)	Create a confidence interval with the given bounds and confidence level.

Method Summary

Modifier and Type	Method	Description
double	getConfidenceLevel()	Get asserted probability that the interval contains the population parameter.
double	getLowerBound()	Get lower endpoint of the interval.
double	getUpperBound()	Get upper endpoint of the interval.
String	toString()	Get String representation of the confidence interval.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfidenceInterval

public ConfidenceInterval(double lowerBound,
                          double upperBound,
                          double confidenceLevel)

Create a confidence interval with the given bounds and confidence level.

Preconditions:

• lower must be strictly less than upper
• confidenceLevel must be strictly between 0 and 1 (exclusive)

Parameters:

lowerBound - lower endpoint of the interval

upperBound - upper endpoint of the interval

confidenceLevel - coverage probability

Throws:

MathIllegalArgumentException - if the preconditions are not met

Method Detail

getLowerBound

public double getLowerBound()

Get lower endpoint of the interval.

Returns:

the lower endpoint of the interval

getUpperBound

public double getUpperBound()

Get upper endpoint of the interval.

Returns:

the upper endpoint of the interval

getConfidenceLevel

public double getConfidenceLevel()

Get asserted probability that the interval contains the population parameter.

Returns:

the asserted probability that the interval contains the population parameter

toString

public String toString()

Get String representation of the confidence interval.

Overrides:

toString in class Object

Returns:

String representation of the confidence interval