asu.seismo.signals.min1d
Interface fminunc1d_iter

All Known Implementing Classes:
fminLBFGS1d

public interface fminunc1d_iter

Unconditioned iterative minimizer for functions of a one dimensional array of real values. This class is a interface, that must be used by all minimization algorithms.


Method Summary
 doubleSignal1d getX()
          Return current x
 boolean isMin()
          Indicate that the minimum has been reached.
 void restart()
          Restart Method
 void setObjective(minimizable1d_fdg f)
          Set the objective function
 void start(doubleSignal1d x0)
          Initiate minimization with initial guess x0
 void step()
          Perform 1 step
 

Method Detail

setObjective

void setObjective(minimizable1d_fdg f)
Set the objective function


start

void start(doubleSignal1d x0)
           throws invalid_data_exception,
                  size_mismatch_exception
Initiate minimization with initial guess x0

Throws:
invalid_data_exception
size_mismatch_exception

restart

void restart()
             throws invalid_data_exception,
                    size_mismatch_exception
Restart Method

Throws:
invalid_data_exception
size_mismatch_exception

step

void step()
          throws invalid_data_exception,
                 size_mismatch_exception,
                 min_failed_exception
Perform 1 step

Throws:
invalid_data_exception
size_mismatch_exception
min_failed_exception

getX

doubleSignal1d getX()
Return current x


isMin

boolean isMin()
              throws invalid_data_exception
Indicate that the minimum has been reached.

Throws:
invalid_data_exception