jsc.ci
Interface ConfidenceBand

All Known Implementing Classes:

KolmogorovCB

public interface ConfidenceBand

Defines the interface for confidence bands.

A confidence band consists of two functions such that the area between the functions' curves includes an unknown function f(x) with a level of confidence measured by the confidence coefficient. The confidence coefficient is a number between 0 and 1 expressing the probability of the truth of a statement that the band will include f(x). Common values chosen for this coefficient are 0.90, 0.95 and 0.99 corresponding to 90%, 95% and 99% confidence levels.

For practical purposes (such as plotting the curves), this interface assumes that the the band is calculated only at n x-values indexed from 0 to n-1. In some circumstances these may be the sorted sample values.

Version:

1.0

Author:

A. J. Bertie.

Method Summary

double	getConfidenceCoeff() Returns the confidence coefficient.
double	getLowerLimit(int i) Returns the value of the lower confidence limit function at the ith x-value.
int	getN() Returns n, the number of indexed values that define the band.
double	getUpperLimit(int i) Returns the value of the upper confidence limit function at the ith x-value.
double	getX(int i) Returns the ith x-value.
void	setConfidenceCoeff(double coeff) Specifies the confidence coefficient.

Method Detail

getConfidenceCoeff

public double getConfidenceCoeff()

Returns the confidence coefficient.

Returns:

the confidence coefficient.

setConfidenceCoeff

public void setConfidenceCoeff(double coeff)

Specifies the confidence coefficient.

Parameters:

coeff - the confidence coefficient; should be between 0 and 1.

getN

public int getN()

Returns n, the number of indexed values that define the band.

Returns:

n.

getLowerLimit

public double getLowerLimit(int i)

Returns the value of the lower confidence limit function at the ith x-value.

Parameters:

i - the index of x; from 0 to n-1.

Returns:

the lower confidence limit.

getUpperLimit

public double getUpperLimit(int i)

Returns the value of the upper confidence limit function at the ith x-value.

Parameters:

i - the index of x; from 0 to n-1.

Returns:

the upper confidence limit.

getX

public double getX(int i)

Returns the ith x-value.

Parameters:

i - the index of x; from 0 to n-1.

Returns:

the ith x-value.