Spatial::FMTSaSchedule Class Reference

Abstract class for a simulated annealing cooling schedule. More...

#include <FMTSaSchedule.h>

Inheritance diagram for Spatial::FMTSaSchedule:

Collaboration diagram for Spatial::FMTSaSchedule:

Public Member Functions
	FMTSaSchedule (const std::string &typesc)
	Construct a FMTSaSchedule from a schedule type.
	FMTSaSchedule ()=default
	Default constructor for FMTSaSchedule.
std::string	getScheduleType () const
	Return the schedule type.
size_t	getLevel () const
	Return the level of the schedule.
void	setInitialTemperature (const double &Temp)
	Set the initial temperature.
virtual	~FMTSaSchedule ()
	Virtual destructor for FMTSaSchedule.
virtual void	reduceTemp ()
	Reduce the temperature according to the cooling schedule.
double	getTemp () const
	Return the current temperature.
void	setTemp (double p_Temp)
	Set the current temperature.
double	getInitialTemp () const
	Return the initial temperature.
virtual std::unique_ptr< FMTSaSchedule >	clone () const
	Return a clone of the FMTSaSchedule.

Protected Attributes
std::string	m_ScheduleType
size_t	m_Level
double	m_Temperature
double	m_InitialTemperature

Detailed Description

Abstract class for a simulated annealing cooling schedule.

Constructor & Destructor Documentation

FMTSaSchedule() [1/2]

Spatial::FMTSaSchedule::FMTSaSchedule

(

const std::string &

typesc

)

Construct a FMTSaSchedule from a schedule type.

Parameters

[in]

typesc

the schedule type.

FMTSaSchedule() [2/2]

Spatial::FMTSaSchedule::FMTSaSchedule ( )

default

Default constructor for FMTSaSchedule.

~FMTSaSchedule()

virtual Spatial::FMTSaSchedule::~FMTSaSchedule

(

)

Virtual destructor for FMTSaSchedule.

Member Function Documentation

clone()

virtual std::unique_ptr< FMTSaSchedule > Spatial::FMTSaSchedule::clone ( ) const

virtual

Return a clone of the FMTSaSchedule.

Returns

a unique pointer to the cloned schedule.

Reimplemented in Spatial::FMTExponentialSchedule.

getInitialTemp()

double Spatial::FMTSaSchedule::getInitialTemp

(

)

const

Return the initial temperature.

Returns

the initial temperature.

getLevel()

size_t Spatial::FMTSaSchedule::getLevel

(

)

const

Return the level of the schedule.

Returns

the level.

getScheduleType()

std::string Spatial::FMTSaSchedule::getScheduleType

(

)

const

Return the schedule type.

Returns

the schedule type.

getTemp()

double Spatial::FMTSaSchedule::getTemp

(

)

const

Return the current temperature.

Returns

the current temperature.

reduceTemp()

virtual void Spatial::FMTSaSchedule::reduceTemp ( )

virtual

Reduce the temperature according to the cooling schedule.

Reimplemented in Spatial::FMTExponentialSchedule.

setInitialTemperature()

void Spatial::FMTSaSchedule::setInitialTemperature

(

const double &

Temp

)

Set the initial temperature.

Parameters

[in]

Temp

the initial temperature.

setTemp()

void Spatial::FMTSaSchedule::setTemp

(

double

p_Temp

)

Set the current temperature.

Parameters

[in]

p_Temp

the temperature.

Member Data Documentation

m_InitialTemperature

double Spatial::FMTSaSchedule::m_InitialTemperature

protected

m_Level

size_t Spatial::FMTSaSchedule::m_Level

protected

m_ScheduleType

std::string Spatial::FMTSaSchedule::m_ScheduleType

protected

m_Temperature

double Spatial::FMTSaSchedule::m_Temperature

protected

---

The documentation for this class was generated from the following file:

• D:/FMT/Include/FMTSaSchedule.h