org.freehep.math.minuit

Class FunctionMinimum

java.lang.Object

org.freehep.math.minuit.FunctionMinimum

public class FunctionMinimum
extends java.lang.Object

Result of the minimization.

The FunctionMinimum is the output of the minimizers and contains the minimization result. The methods

• userState(),
• userParameters() and
• userCovariance()

are provided. These can be used as new input to a new minimization after some manipulation. The parameters and/or the FunctionMinimum can be printed using the toString() method or the MnPrint class.

See Also:

userState(), userParameters(), userCovariance(), MnPrint

Method Summary

Modifier and Type	Method and Description
double	edm() returns the expected vertical distance to the minimum (EDM)
double	errorDef()
double	fval() Returns the function value at the minimum.
boolean	isValid() In general, if this returns true, the minimizer did find a minimum without running into troubles.
int	nfcn() returns the total number of function calls during the minimization.
java.lang.String	toString()
MnUserCovariance	userCovariance()
MnUserParameters	userParameters()
MnUserParameterState	userState() user representation of state at minimum

Methods inherited from class java.lang.Object

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

Method Detail

userState

public MnUserParameterState userState()

user representation of state at minimum

userParameters

public MnUserParameters userParameters()

userCovariance

public MnUserCovariance userCovariance()

fval

public double fval()

Returns the function value at the minimum.

edm

public double edm()

returns the expected vertical distance to the minimum (EDM)

nfcn

public int nfcn()

returns the total number of function calls during the minimization.

errorDef

public double errorDef()

isValid

public boolean isValid()

In general, if this returns true, the minimizer did find a minimum without running into troubles. However, in some cases a minimum cannot be found, then the return value will be false. Reasons for the minimization to fail are

• the number of allowed function calls has been exhausted

the minimizer could not improve the values of the parameters (and knowing that it has not converged yet) a problem with the calculation of the covariance matrix Additional methods for the analysis of the state at the minimum are provided.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object