hep.aida.ref.fitter.fitdata

Class FitDataIterator

java.lang.Object

hep.aida.ref.fitter.fitdata.FitDataIterator

All Implemented Interfaces:

IDevFitDataIterator

public class FitDataIterator
extends java.lang.Object
implements IDevFitDataIterator

Constructor Summary

Constructors

Constructor and Description
FitDataIterator(ITuple tuple)

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FitDataIterator

public FitDataIterator(ITuple tuple)

Method Detail

entries

public int entries()

Description copied from interface: IDevFitDataIterator

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.

Specified by:

entries in interface IDevFitDataIterator

Returns:

The total number of entries.

next

public boolean next()

Description copied from interface: IDevFitDataIterator

Move the iterator to the next element of the IFitData.

Specified by:

next in interface IDevFitDataIterator

Returns:

true If the iterator is positioned on a valide element.

start

public void start()

Description copied from interface: IDevFitDataIterator

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

Specified by:

start in interface IDevFitDataIterator

value

public double value()

Description copied from interface: IDevFitDataIterator

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

Specified by:

value in interface IDevFitDataIterator

Returns:

The value for the current element.

error

public double error()

Description copied from interface: IDevFitDataIterator

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.

Specified by:

error in interface IDevFitDataIterator

Returns:

The error for the current element.

minusError

public double minusError()

Description copied from interface: IDevFitDataIterator

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().

Specified by:

minusError in interface IDevFitDataIterator

Returns:

The minus error.

vars

public double[] vars()

Description copied from interface: IDevFitDataIterator

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.

Specified by:

vars in interface IDevFitDataIterator

Returns:

The array of variables for the current data element.