hep.aida.ref.optimizer
Class OptimizerResult

java.lang.Object
  |
  +--hep.aida.ref.optimizer.OptimizerResult

All Implemented Interfaces:

IOptimizerResult

public class OptimizerResult

extends Object

implements IOptimizerResult

Implementation of IOptimizerResult

Author:

Tony Johnson, Victor Serbo, Max Turri

Field Summary

Fields inherited from interface hep.aida.ext.IOptimizerResult

APPROXIMATE, CONVERGED, CONVERGED_NEG_MATRIX, CONVERGED_SMALL_GRADIENT, CONVERGED_SMALL_STEP_SIZE, NOT_CONVERGED, REACHED_MAX_ITER, TOO_MANY_LARGE_STEPS, UNDEFINED

Constructor Summary

OptimizerResult()
Creates a new instance of OptimizerResult

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.
hep.aida.IFunction	function() The function that has been optimized.
hep.aida.IFunction[]	functions() The functions that have been optimized.
int	optimizationStatus() The status of the optimizer after the optimization procedure.
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.
void	setCorrelationMatrix(double[][] corrMatrix)
void	setCovarianceMatrix(double[][] covMatrix)
void	setOptimizationStatus(int status)

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizerResult

public OptimizerResult()

Creates a new instance of OptimizerResult

Method Detail

function

public hep.aida.IFunction function()

The function that has been optimized.

Specified by:

function in interface IOptimizerResult

Returns:

The optimized function.

functions

public hep.aida.IFunction[] functions()

The functions that have been optimized.

Returns:

The optimized functions.

constraints

public IDomainConstraint constraints()

The constraints used in the optimization.

Specified by:

constraints in interface IOptimizerResult

Returns:

The domain of constraints.

configuration

public IOptimizerConfiguration configuration()

The optimizer's configuration.

Specified by:

configuration in interface IOptimizerResult

Returns:

The optimizer's configuration.

covarianceMatrix

public double[][] covarianceMatrix()

The covariance matrix. Still under discussion

Specified by:

covarianceMatrix in interface IOptimizerResult

setCovarianceMatrix

public void setCovarianceMatrix(double[][] covMatrix)

correlationMatrix

public double[][] correlationMatrix()

The correlation matrix. Still under discussion.

Specified by:

correlationMatrix in interface IOptimizerResult

setCorrelationMatrix

public void setCorrelationMatrix(double[][] corrMatrix)

contour

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

Get the contour with respec to two variables.

Specified by:

contour in interface IOptimizerResult

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.

Specified by:

scan in interface IOptimizerResult

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.

Specified by:

scan in interface IOptimizerResult

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.

Specified by:

optimizationStatus in interface IOptimizerResult

Returns:

The status of the optimization.

setOptimizationStatus

public void setOptimizationStatus(int status)