Package org.opt4j.optimizer.sa

Class CoolingSchedulesModule

java.lang.Object

com.google.inject.AbstractModule

org.opt4j.start.Opt4JModule

org.opt4j.optimizer.sa.CoolingScheduleModule

org.opt4j.optimizer.sa.CoolingSchedulesModule

All Implemented Interfaces:

com.google.inject.Module

public class CoolingSchedulesModule
extends CoolingScheduleModule

This module provides several common CoolingSchedules for the SimulatedAnnealing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CoolingSchedulesModule.Type	Type of CoolingSchedule to use.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	alpha
protected double	finalTemperature
protected double	initialTemperature
protected CoolingSchedulesModule.Type	type

Fields inherited from class org.opt4j.start.Opt4JModule

SINGLETON

Constructor Summary

Constructors

Constructor	Description
CoolingSchedulesModule()	Constructs a CoolingSchedulesModule.

Method Summary

Modifier and Type	Method	Description
void	config()	Configure the module.
double	getAlpha()	Returns the alpha value.
double	getFinalTemperature()	Returns the final temperature.
double	getInitialTemperature()	Returns the initial temperature.
CoolingSchedulesModule.Type	getType()	Returns the type of cooling schedule.
void	setAlpha(double alpha)	Sets the alpha value.
void	setFinalTemperature(double finalTemperature)	Sets the final temperature.
void	setInitialTemperature(double initialTemperature)	Sets the initial temperature.
void	setType(CoolingSchedulesModule.Type type)	Sets the type of cooling schedule.

Methods inherited from class org.opt4j.optimizer.sa.CoolingScheduleModule

bindCoolingSchedule

Methods inherited from class org.opt4j.start.Opt4JModule

addControlListener, addIndividualStateListener, addOptimizerIterationListener, addOptimizerStateListener, bindConstant, bindConstant, bindConstant, bindConstant, configure, constant, multi

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Field Details

initialTemperature

protected double initialTemperature

finalTemperature

protected double finalTemperature

alpha

protected double alpha

type

protected CoolingSchedulesModule.Type type

Constructor Details

CoolingSchedulesModule

public CoolingSchedulesModule()

Constructs a CoolingSchedulesModule.

Method Details

getFinalTemperature

public double getFinalTemperature()

Returns the final temperature.

Returns:

the final temperature

See Also:

• setFinalTemperature(double)

setFinalTemperature

public void setFinalTemperature(double finalTemperature)

Sets the final temperature.

Parameters:

finalTemperature - the final temperature

See Also:

• getFinalTemperature()

getInitialTemperature

public double getInitialTemperature()

Returns the initial temperature.

Returns:

the initial temperature

See Also:

• setInitialTemperature(double)

setInitialTemperature

public void setInitialTemperature(double initialTemperature)

Sets the initial temperature.

Parameters:

initialTemperature - the initial temperature

See Also:

• getInitialTemperature()

getType

public CoolingSchedulesModule.Type getType()

Returns the type of cooling schedule.

Returns:

the type of cooling schedule

See Also:

• setType(org.opt4j.optimizer.sa.CoolingSchedulesModule.Type)

setType

public void setType(CoolingSchedulesModule.Type type)

Sets the type of cooling schedule.

Parameters:

type - the type of cooling schedule

See Also:

• getType()

getAlpha

public double getAlpha()

Returns the alpha value.

Returns:

the alpha value

See Also:

• setAlpha(double)

setAlpha

public void setAlpha(double alpha)

Sets the alpha value.

Parameters:

alpha - the alpha value

See Also:

• getAlpha()

config

public void config()

Description copied from class: Opt4JModule

Configure the module. Bind constants, listeners, and bind arbitrary classes.

Specified by:

config in class Opt4JModule

See Also:

• Binder