FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Spatial::FMTExponentialSchedule Class Reference

Exponential cooling schedule for simulated annealing, reducing the temperature by a constant annealing rate. More...

#include <FMTExponentialSchedule.h>

Inheritance diagram for Spatial::FMTExponentialSchedule:
[legend]
Collaboration diagram for Spatial::FMTExponentialSchedule:
[legend]

Public Member Functions

 FMTExponentialSchedule ()
 Default constructor for FMTExponentialSchedule.
 
 ~FMTExponentialSchedule ()=default
 Default destructor for FMTExponentialSchedule.
 
void reduceTemp ()
 Reduce the temperature using the exponential annealing rate.
 
std::unique_ptr< FMTSaScheduleclone () const
 Return a clone of the FMTExponentialSchedule.
 
void setAnnealingRate (const double &p_annealingRate)
 Set the annealing rate.
 
- Public Member Functions inherited from Spatial::FMTSaSchedule
 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< FMTSaScheduleclone () const
 Return a clone of the FMTSaSchedule.
 

Additional Inherited Members

- Protected Attributes inherited from Spatial::FMTSaSchedule
std::string m_ScheduleType
 
size_t m_Level
 
double m_Temperature
 
double m_InitialTemperature
 

Detailed Description

Exponential cooling schedule for simulated annealing, reducing the temperature by a constant annealing rate.

Constructor & Destructor Documentation

◆ FMTExponentialSchedule()

Spatial::FMTExponentialSchedule::FMTExponentialSchedule ( )

Default constructor for FMTExponentialSchedule.

◆ ~FMTExponentialSchedule()

Spatial::FMTExponentialSchedule::~FMTExponentialSchedule ( )
default

Default destructor for FMTExponentialSchedule.

Member Function Documentation

◆ clone()

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

Return a clone of the FMTExponentialSchedule.

Returns
a unique pointer to the cloned schedule.

Reimplemented from Spatial::FMTSaSchedule.

◆ reduceTemp()

void Spatial::FMTExponentialSchedule::reduceTemp ( )
virtual

Reduce the temperature using the exponential annealing rate.

Reimplemented from Spatial::FMTSaSchedule.

◆ setAnnealingRate()

void Spatial::FMTExponentialSchedule::setAnnealingRate ( const double &  p_annealingRate)

Set the annealing rate.


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