Optimizers

Interface Optimizer

All Known Implementing Classes:

ConjugateGradient, GoldenSection, NelderMead

public interface Optimizer

Interface for different likelihood optimisers

Version:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Optimizer.OptimizerException Exception for when there is a problem with an optimiser.

Method Summary

Methods

Modifier and Type	Method and Description
<R extends Likelihood> R	maximise(Optimizable<R> l, Parameters p) Maximises the likelihood, logging to screen.
<R extends Likelihood> R	maximise(Optimizable<R> l, Parameters params, java.io.File log) Maximises the likelihood, logging to a file.
<R extends Likelihood> R	restart(Optimizable<R> l, java.io.File checkPoint) Maximises the likelihood starting from a checkpoint file (see setCheckPointFile(java.io.File), logging to the screen.
<R extends Likelihood> R	restart(Optimizable<R> l, java.io.File checkPoint, java.io.File log) Maximises the likelihood starting from a checkpoint file (see setCheckPointFile(java.io.File), logging to a file.
void	setCheckPointFile(java.io.File checkPoint) Sets a checkpoint file.
void	setCheckPointFrequency(int num, java.util.concurrent.TimeUnit unit) Sets how often a checkpoint is saved (if a file has been set).
void	setMaximumRunTime(int num, java.util.concurrent.TimeUnit unit) Set a maximum time the optimiser should run for

Method Detail

maximise

<R extends Likelihood> R maximise(Optimizable<R> l,
                                Parameters p)
                              throws GeneralException

Maximises the likelihood, logging to screen. Logging level should be set in the constructor of implementing classes.

Type Parameters:

R - The type returned by the calculator

Parameters:

l - The likelihood calculator

p - The parameters to maximise. Parameters are modified.

Returns:

The maximised likelihood (in a structure that includes most intermediate likelihoods).

Throws:

GeneralException - When there is a problem in finding an optimisable solution.

maximise

<R extends Likelihood> R maximise(Optimizable<R> l,
                                Parameters params,
                                java.io.File log)
                              throws GeneralException

Maximises the likelihood, logging to a file. Logging level should be set in the constructor of implementing classes.

Type Parameters:

R - The type returned by the calculator

Parameters:

l - The likelihood calculator

params - The parameters to maximise. Parameters are modified.

log - The log file

Returns:

The maximised likelihood (in a structure that includes most intermediate likelihoods).

Throws:

GeneralException - When there is a problem in finding an optimisable solution

restart

<R extends Likelihood> R restart(Optimizable<R> l,
                               java.io.File checkPoint)
                             throws GeneralException

Maximises the likelihood starting from a checkpoint file (see setCheckPointFile(java.io.File), logging to the screen. Logging level should be set in the constructor of implementing classes.

Type Parameters:

R - The type returned by the calculator

Parameters:

l - The likelihood calculator

checkPoint - The checkpoint file

Returns:

The maximised likelihood (in a structure that includes most intermediate likelihoods).

Throws:

GeneralException - When there is a problem in finding an optimisable solution

restart

<R extends Likelihood> R restart(Optimizable<R> l,
                               java.io.File checkPoint,
                               java.io.File log)
                             throws GeneralException

Maximises the likelihood starting from a checkpoint file (see setCheckPointFile(java.io.File), logging to a file. Logging level should be set in the constructor of implementing classes.

Type Parameters:

R - The type returned by the calculator

Parameters:

l - The likelihood calculator

checkPoint - The checkpoint file

log - The log file

Returns:

The maximised likelihood (in a structure that includes most intermediate likelihoods).

Throws:

GeneralException - When there is a problem in finding an optimisable solution

setCheckPointFile

void setCheckPointFile(java.io.File checkPoint)
                       throws Optimizer.OptimizerException

Sets a checkpoint file. If set will write a checkpoint file of the optimisers state at regular intervals (set by setCheckPointFrequency(int, java.util.concurrent.TimeUnit)). This checkpoint file can then be used to restart the optimiser from this state. Can be useful if optimisation is likely to take a long and the process could be stopped for some reason.

Parameters:

checkPoint - The chekpoint file.

Throws:

Optimizer.OptimizerException - Thrown if the optomiser does not implement checkpoints.

setCheckPointFrequency

void setCheckPointFrequency(int num,
                          java.util.concurrent.TimeUnit unit)
                            throws Optimizer.OptimizerException

Sets how often a checkpoint is saved (if a file has been set).

Parameters:

num - The number of time units that should pass between checkpoint writes.

unit - The time unit

Throws:

Optimizer.OptimizerException - Thrown if the optomiser does not implement checkpoints.

setMaximumRunTime

void setMaximumRunTime(int num,
                     java.util.concurrent.TimeUnit unit)
                       throws Optimizer.OptimizerException

Set a maximum time the optimiser should run for

Parameters:

num - The number of time units that should pass between checkpoint writes.

unit - The time unit

Throws:

Optimizer.OptimizerException - Thrown if the optimiser does not implement a maximum run time.