hep.aida.dev

Interface IDevFitDataIterator

All Known Implementing Classes:

FitDataIterator

public interface IDevFitDataIterator

Iterator for the fit data allows to decouple abstract representation of data and independently traverse the data in the inner fitting loop.

Method Summary

Modifier and Type	Method and Description
int	entries() Get the total number of entries on which the iterator is supposed to loop on.
double	error() For Chi2-type fits it returns the error for the current element for the evaluation of the chi2 contribution of the current element.
double	minusError() If the IFitData provides asymmetric errors it returns the negative error on the current element.
boolean	next() Move the iterator to the next element of the IFitData.
void	start() Position the iterator at the start.
double	value() For Chi2-type fits it returns the "height" for evaluating the contribution to the chi2 for the current element.
double[]	vars() Get the array containing the variables for the current data element.

Method Detail

start

void start()

Position the iterator at the start. The starting position is right before the first element.

next

boolean next()

Move the iterator to the next element of the IFitData.

Returns:

true If the iterator is positioned on a valide element.

entries

int entries()

Get the total number of entries on which the iterator is supposed to loop on. This is needed to calculate the Chi2 of a fit.

Returns:

The total number of entries.

vars

double[] vars()

Get the array containing the variables for the current data element. The variables should be already in the right order for the value() method of the IFunction.

Returns:

The array of variables for the current data element.

value

double value()
      throws java.lang.RuntimeException

For Chi2-type fits it returns the "height" for evaluating the contribution to the chi2 for the current element.

Returns:

The value for the current element.

Throws:

java.lang.RuntimeException - if the value is not available, like in unbinned-type fits.

error

double error()
      throws java.lang.RuntimeException

For Chi2-type fits it returns the error for the current element for the evaluation of the chi2 contribution of the current element. If the IFitData provides asymmetric errors it returns the positive error.

Returns:

The error for the current element.

Throws:

java.lang.RuntimeException - if the error is not available, like in unbinned-type fits.

minusError

double minusError()
           throws java.lang.RuntimeException

If the IFitData provides asymmetric errors it returns the negative error on the current element. Otherwise it returns the same value returned by the method error().

Returns:

The minus error.

Throws:

java.lang.RuntimeException - if the error is not available, like in unbinned-type fits.