net.sourceforge.jannealer
Class Schedule

java.lang.Object
  |
  +--net.sourceforge.jannealer.Schedule

class Schedule
extends java.lang.Object

This class contains the Annealing scheme. It is mostly a JAVA wrapper around two functions : amebsa and amotsa in Press, Teukolsky, Vetterling and Flannery, "Numerical Recipes in C", Cambridge University Press, 2nd edition, 1994. The original versions of amebsa and amotsa can be found on pages 452 and 454 respectively.

Since:
November 3, 2001

Constructor Summary
protected Schedule(AnnealingScheme scheme)
          Constructor for the Schedule object
 
Method Summary
protected  void amebsa(double ftol, double temptr, long idum)
          Multi-dimensional minimization algorithm.
protected  double amotsa(int ndim, int ihi, double yhi, double fac, long idum, double tt)
          Extrapolation through the face of the Simplex
protected  void contract(int mpts, int ilo)
          Contraction utility
protected  double fluctuate(int yIndex, double tt, long idum)
          Description of the Method
protected  int getIter()
          Gets the Iter attribute of the Schedule object
protected  int getNp()
          Gets the Np attribute of the Schedule object
protected  double[][] getP()
          Gets the P attribute of the Schedule object
protected  double getP(int ii, int jj)
          Gets the P attribute of the Schedule object at requested index
protected  double[] getPb()
          Gets the Pb attribute of the Schedule object
protected  double getPb(int ii)
          Gets the Pb attribute of the Schedule object
protected  double[] getY()
          Gets the Y attribute of the Schedule object
protected  double getY(int ii)
          Gets the Y attribute of the Schedule object
protected  double getYb()
          Gets the Yb attribute of the Schedule object
protected  void increaseIter(int dIter)
          Increments the attribute iter by dIter
protected  void initializeP()
          Description of the Method
protected  void setIter(int iter)
          Sets the Iter attribute of the Schedule object
protected  void setPDiagonal()
          Sets the PDiagonal attribute of the Schedule object
protected  void setPsum(int mpts)
          Sets the Psum attribute of the Schedule object
protected  void setY(double[] xoff)
          Sets the Y attribute of the Schedule object
protected  void setYb(double yb)
          Sets the Yb attribute of the Schedule object
protected  void swap(int ilo)
          Swapping utility
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Schedule

protected Schedule(AnnealingScheme scheme)
Constructor for the Schedule object
Parameters:
scheme - Description of Parameter
Throws:
java.lang.InstantiationException - Description of Exception
java.lang.IllegalAccessException - Description of Exception
Method Detail

setPsum

protected void setPsum(int mpts)
Sets the Psum attribute of the Schedule object
Parameters:
mpts - The new Psum value

setIter

protected void setIter(int iter)
Sets the Iter attribute of the Schedule object
Parameters:
iter - The new Iter value

setYb

protected void setYb(double yb)
Sets the Yb attribute of the Schedule object
Parameters:
yb - The new Yb value

setY

protected void setY(double[] xoff)
Sets the Y attribute of the Schedule object
Parameters:
xoff - The new Y value

setPDiagonal

protected void setPDiagonal()
Sets the PDiagonal attribute of the Schedule object

getNp

protected int getNp()
Gets the Np attribute of the Schedule object
Returns:
The Np value

getPb

protected double[] getPb()
Gets the Pb attribute of the Schedule object
Returns:
The Pb value

getPb

protected double getPb(int ii)
Gets the Pb attribute of the Schedule object
Parameters:
ii - Description of Parameter
Returns:
The Pb value

getIter

protected int getIter()
Gets the Iter attribute of the Schedule object
Returns:
The Iter value

getYb

protected double getYb()
Gets the Yb attribute of the Schedule object
Returns:
The Yb value

getY

protected double[] getY()
Gets the Y attribute of the Schedule object
Returns:
The Y value

getY

protected double getY(int ii)
Gets the Y attribute of the Schedule object
Parameters:
ii - Description of Parameter
Returns:
The Y value

getP

protected double[][] getP()
Gets the P attribute of the Schedule object
Returns:
The P value

getP

protected double getP(int ii,
                      int jj)
Gets the P attribute of the Schedule object at requested index
Parameters:
ii - The i index
jj - The j index
Returns:
The P[ii][jj] value

amebsa

protected void amebsa(double ftol,
                      double temptr,
                      long idum)
Multi-dimensional minimization algorithm.
Parameters:
ftol - The fractional tolerance
temptr - The temperature
idum - The random number generator seed

initializeP

protected void initializeP()
Description of the Method

swap

protected void swap(int ilo)
Swapping utility
Parameters:
ilo - Description of Parameter

contract

protected void contract(int mpts,
                        int ilo)
Contraction utility
Parameters:
mpts - Description of Parameter
ilo - Description of Parameter

fluctuate

protected double fluctuate(int yIndex,
                           double tt,
                           long idum)
Description of the Method
Parameters:
yIndex - Description of Parameter
tt - Description of Parameter
idum - Description of Parameter
Returns:
Description of the Returned Value

amotsa

protected double amotsa(int ndim,
                        int ihi,
                        double yhi,
                        double fac,
                        long idum,
                        double tt)
Extrapolation through the face of the Simplex
Parameters:
ndim - Description of Parameter
ihi - Description of Parameter
yhi - Description of Parameter
fac - Description of Parameter
idum - Description of Parameter
tt - Description of Parameter
Returns:
Description of the Returned Value

increaseIter

protected void increaseIter(int dIter)
Increments the attribute iter by dIter
Parameters:
dIter - The increment