hep.aida.ext
Interface IOptimizerResult

All Known Implementing Classes:

OptimizerResult

public interface IOptimizerResult

Source Code:

IOptimizerResult.java

Field Summary

static int	APPROXIMATE
static int	CONVERGED
static int	CONVERGED_NEG_MATRIX
static int	CONVERGED_SMALL_GRADIENT
static int	CONVERGED_SMALL_STEP_SIZE
static int	NOT_CONVERGED
static int	REACHED_MAX_ITER
static int	TOO_MANY_LARGE_STEPS
static int	UNDEFINED

Method Summary

IOptimizerConfiguration	configuration() The optimizer's configuration.
IDomainConstraint	constraints() The constraints used in the optimization.
Object	contour(int nSigma, int nPoints, IVariable var1, IVariable var2) Get the contour with respec to two variables.
double[][]	correlationMatrix() The correlation matrix.
double[][]	covarianceMatrix() The covariance matrix.
int	optimizationStatus() The status of the optimizer after the optimization procedure.
double[]	parameters()
Object	scan(int nPoints, IVariable var) Scan the function with respect to a variable.
Object	scan(int nPoints, IVariable var1, IVariable var2) Scan the function with respect to two variables.

Field Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

APPROXIMATE

public static final int APPROXIMATE

See Also:

Constant Field Values

CONVERGED_NEG_MATRIX

public static final int CONVERGED_NEG_MATRIX

See Also:

Constant Field Values

CONVERGED

public static final int CONVERGED

See Also:

Constant Field Values

CONVERGED_SMALL_GRADIENT

public static final int CONVERGED_SMALL_GRADIENT

See Also:

Constant Field Values

CONVERGED_SMALL_STEP_SIZE

public static final int CONVERGED_SMALL_STEP_SIZE

See Also:

Constant Field Values

NOT_CONVERGED

public static final int NOT_CONVERGED

See Also:

Constant Field Values

REACHED_MAX_ITER

public static final int REACHED_MAX_ITER

See Also:

Constant Field Values

TOO_MANY_LARGE_STEPS

public static final int TOO_MANY_LARGE_STEPS

See Also:

Constant Field Values

Method Detail

constraints

public IDomainConstraint constraints()

The constraints used in the optimization.

Returns:

The domain of constraints.

configuration

public IOptimizerConfiguration configuration()

The optimizer's configuration.

Returns:

The optimizer's configuration.

parameters

public double[] parameters()

covarianceMatrix

public double[][] covarianceMatrix()

The covariance matrix. Still under discussion

correlationMatrix

public double[][] correlationMatrix()

The correlation matrix. Still under discussion.

contour

public Object contour(int nSigma,
                      int nPoints,
                      IVariable var1,
                      IVariable var2)

Get the contour with respec to two variables.

Parameters:

nSigma - The number of sigmas at which the contour should be calculated.

nPoints - The maximum number of points on the contour (might be less).

var1 - The first variable.

var2 - The second variable.

Returns:

The Object containing the contour (to be fixed).

scan

public Object scan(int nPoints,
                   IVariable var1,
                   IVariable var2)

Scan the function with respect to two variables.

Parameters:

nPoints - The number of points to be used in the scan.

var1 - The first variable.

var2 - The second variable.

Returns:

The Object containing the scan (to be fixed).

scan

public Object scan(int nPoints,
                   IVariable var)

Scan the function with respect to a variable.

Parameters:

nPoints - The number of points to be used in the scan.

var - The variable.

Returns:

The Object containing the scan (to be fixed).

optimizationStatus

public int optimizationStatus()

The status of the optimizer after the optimization procedure.

Returns:

The status of the optimization.