bb.science
Class Bootstrap.Estimate

java.lang.Object
  extended by bb.science.Bootstrap.Estimate
Enclosing class:
Bootstrap

public static class Bootstrap.Estimate
extends Object

Holds a complete (point and interval) estimate for some Bootstrap.Estimator.

This class is multithread safe: it is immutable (both its immediate state, as well as the deep state of its fields).


Field Summary
protected  double confidenceLevel
          Specifies the confidence level of the confidence intervals.
protected  double lower
          Is the lower bound (start of the confidence interval) of the estimate.
protected  double point
          Records a single value ("point") estimate.
protected  double upper
          Is the upper bound (end of the confidence interval) of the estimate.
 
Constructor Summary
Bootstrap.Estimate(double point, double lower, double upper, double confidenceLevel)
           
 
Method Summary
 boolean confidenceIntervalContains(double value)
           
 double getConfidenceLevel()
           
 double getLower()
           
 double getPoint()
           
 double getUpper()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

point

protected final double point
Records a single value ("point") estimate. This value may or may not be the maximum likelihood estimate (it totally depends on the Estimator used).

Contract: may be any value, including NaN (if undefined) or infinity.


lower

protected final double lower
Is the lower bound (start of the confidence interval) of the estimate.

Contract: may be any value, including NaN (if undefined) or infinity. However, if NaN, then upper must also be NaN, and if not NaN, then upper must also be not NaN and lower must be <= upper.


upper

protected final double upper
Is the upper bound (end of the confidence interval) of the estimate.

Contract: same as lower.


confidenceLevel

protected final double confidenceLevel
Specifies the confidence level of the confidence intervals.

Units: none; is a dimensionless fractional number in the range (0, 1).

Note: the percent confidence level is 100 times this quantity.

Contract: must be inside the open interval (0, 1), and is never NaN or infinite.

See Also:
article on confidence intervals
Constructor Detail

Bootstrap.Estimate

public Bootstrap.Estimate(double point,
                          double lower,
                          double upper,
                          double confidenceLevel)
                   throws IllegalArgumentException
Throws:
IllegalArgumentException
Method Detail

getPoint

public double getPoint()

getLower

public double getLower()

getUpper

public double getUpper()

getConfidenceLevel

public double getConfidenceLevel()

toString

public String toString()
Overrides:
toString in class Object

confidenceIntervalContains

public boolean confidenceIntervalContains(double value)
                                   throws IllegalArgumentException
Throws:
IllegalArgumentException