Apache Commons Math 3.6.1 · org.apache.commons.math3.stat.interval.ConfidenceInterval

Field Summary

Modifier and Type	Field and Description
private double	confidenceLevel The asserted probability that the interval contains the population parameter
private double	lowerBound Lower endpoint of the interval
private double	upperBound Upper endpoint of the interval

Constructor Summary

Access	Constructor and Description
public	ConfidenceInterval(double lower endpoint of the interval lowerBound, double upper endpoint of the interval upperBound, double coverage probability confidenceLevel) Create a confidence interval with the given bounds and confidence level.

Method Summary

Modifier and Type	Method and Description
private void	checkParameters(double lower endpoint lower, double upper endpoint upper, double confidence level confidence) Verifies that (lower, upper) is a valid non-empty interval and confidence is strictly between 0 and 1.
public double	Returns: the asserted probability that the interval contains the population parameter getConfidenceLevel()
public double	Returns: the lower endpoint of the interval getLowerBound()
public double	Returns: the upper endpoint of the interval getUpperBound()
public String	Returns: String representation of the confidence interval toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

confidenceLevel	back to summary
private double confidenceLevel The asserted probability that the interval contains the population parameter

lowerBound	back to summary
private double lowerBound Lower endpoint of the interval

upperBound	back to summary
private double upperBound Upper endpoint of the interval

Constructor Detail

ConfidenceInterval back to summary

ConfidenceInterval	back to summary
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:double lower endpoint of the interval upperBound:double upper endpoint of the interval confidenceLevel:double coverage probability Exceptions MathIllegalArgumentException: if the preconditions are not met

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:double: lower endpoint of the interval
upperBound:double: upper endpoint of the interval
confidenceLevel:double: coverage probability

Exceptions

MathIllegalArgumentException:: if the preconditions are not met

Method Detail

checkParameters	back to summary
private void checkParameters(double lower, double upper, double confidence) Verifies that (lower, upper) is a valid non-empty interval and confidence is strictly between 0 and 1. Parameters lower:double lower endpoint upper:double upper endpoint confidence:double confidence level

checkParameters

back to summary

private void checkParameters(double lower, double upper, double confidence)

Verifies that (lower, upper) is a valid non-empty interval and confidence is strictly between 0 and 1.

Parameters

lower:double: lower endpoint
upper:double: upper endpoint
confidence:double: confidence level

getConfidenceLevel	back to summary
public double getConfidenceLevel() Returns:double the asserted probability that the interval contains the population parameter

getLowerBound	back to summary
public double getLowerBound() Returns:double the lower endpoint of the interval

getUpperBound	back to summary
public double getUpperBound() Returns:double the upper endpoint of the interval

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String String representation of the confidence interval Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

String representation of the confidence interval

Annotations

@Override