biz.sc.mm.dm.supervised.statistical

Interface OptimizationAlgorithmSettings

All Superinterfaces:

Verifiable

public interface OptimizationAlgorithmSettings
extends Verifiable

Common settings for nonlinear optimization methods.

Method Summary

Methods

Modifier and Type	Method and Description
ConvergenceCriterion	getConvergenceCriterion() Gets convergence criterion for nonlinear optimization method (e.g.gradient norm or likelihood change).
double	getConvergenceThreshold()
double	getFunctionTolerance() Gets function tolerance for nonlinear optimization method.
double	getGradientTolerance() Gets gradient tolerance for nonlinear optimization method.
int	getIterMax() Gets maximum number of iterations for nonlinear optimization method.
int	getMaxFunEvaluations()
boolean	getOptimizationInformation() Sets switch for additional info from OPT++ library.
NonlinearOptimizationMethod	getOptimizationMethod() Gets nonlinear optimization method (e.g.Newton-Raphson with step halving).
SearchStrategy	getSearchStrategy()
void	setConvergenceCriterion(ConvergenceCriterion criterion) Sets current convergence criterion for nonlinear optimization method (e.g.gradient norm or likelihood change).
void	setConvergenceThreshold(double threshold)
void	setFunctionTolerance(double tolerance) Sets function tolerance for nonlinear optimization method.
void	setGradientTolerance(double tolerance) Sets gradient tolerance for nonlinear optimization method.
void	setIterMax(int iter) Sets maximum number of iterations for nonlinear optimization method.
void	setMaxFunEvaluations(int maxFunEvals)
void	setOptimizationInformation(boolean info) Gets switch for additional info from OPT++ library.
void	setOptimizationMethod(NonlinearOptimizationMethod method) Sets nonlinear optimization method (e.g.Newton-Raphson with step halving).
void	setSearchStrategy(SearchStrategy strategy)

Methods inherited from interface biz.sc.mm.dm.base.Verifiable

verify

Method Detail

getOptimizationMethod

NonlinearOptimizationMethod getOptimizationMethod()

Gets nonlinear optimization method (e.g.Newton-Raphson with step halving).

Returns:

nonlinear optimization method.

setOptimizationMethod

void setOptimizationMethod(NonlinearOptimizationMethod method)

Sets nonlinear optimization method (e.g.Newton-Raphson with step halving).

Parameters:

method - nonlinear optimization method.

getConvergenceCriterion

ConvergenceCriterion getConvergenceCriterion()

Gets convergence criterion for nonlinear optimization method (e.g.gradient norm or likelihood change).

Returns:

convergence criterion for nonlinear optimization method.

setConvergenceCriterion

void setConvergenceCriterion(ConvergenceCriterion criterion)

Sets current convergence criterion for nonlinear optimization method (e.g.gradient norm or likelihood change).

Parameters:

criterion - convergence criterion for nonlinear optimization method.

getIterMax

int getIterMax()

Gets maximum number of iterations for nonlinear optimization method.

Returns:

maximum number of iterations.

setIterMax

void setIterMax(int iter)

Sets maximum number of iterations for nonlinear optimization method.

Parameters:

iter - maximum number of iterations.

getFunctionTolerance

double getFunctionTolerance()

Gets function tolerance for nonlinear optimization method.

Returns:

function tolerance value.

setFunctionTolerance

void setFunctionTolerance(double tolerance)

Sets function tolerance for nonlinear optimization method.

Parameters:

function - tolerance value.

getGradientTolerance

double getGradientTolerance()

Gets gradient tolerance for nonlinear optimization method.

Returns:

gradient tolerance value.

setGradientTolerance

void setGradientTolerance(double tolerance)

Sets gradient tolerance for nonlinear optimization method.

Parameters:

gradient - tolerance value.

getConvergenceThreshold

double getConvergenceThreshold()

setConvergenceThreshold

void setConvergenceThreshold(double threshold)

getOptimizationInformation

boolean getOptimizationInformation()

Sets switch for additional info from OPT++ library.

Returns:

additional info switch value.

setOptimizationInformation

void setOptimizationInformation(boolean info)

Gets switch for additional info from OPT++ library.

Parameters:

info - true if additional info from OPT++ library should be shown in logs.

getSearchStrategy

SearchStrategy getSearchStrategy()

setSearchStrategy

void setSearchStrategy(SearchStrategy strategy)

getMaxFunEvaluations

int getMaxFunEvaluations()

setMaxFunEvaluations

void setMaxFunEvaluations(int maxFunEvals)