Djinni  2.2
Public Types | Public Member Functions | Protected Attributes
Simulated Class Reference

A class representing classical simulated annealing. More...

#include <Penalties.h>

List of all members.

Public Types

typedef double ReturnType

Public Member Functions

 Simulated ()
 Simulated (const double multiplier)
 Simulated (const Simulated &sim)
virtual ~Simulated ()
void setMultiplier (const double multiplier)
ReturnType operator() (const int) const

Protected Attributes

double _mult

Detailed Description

A class representing classical simulated annealing.

Warning:
This class has not been tested. Please do not rely on its correct operation.
Author:
Hansen, Thiede
Since:
2.1

Definition at line 125 of file Penalties.h.


Member Typedef Documentation

typedef double Simulated::ReturnType

Like compressed annealing, simulated annealing uses doubles for its lambda.

Definition at line 129 of file Penalties.h.


Constructor & Destructor Documentation

Simulated::Simulated ( ) [inline]

A convenience constructor which initializes the multiplier to 1.0.

Definition at line 132 of file Penalties.h.

Simulated::Simulated ( const double  multiplier) [inline]

A constructor that sets the multiplier for use in simulated annealing.

Parameters:
multiplierThe multiplier to use

Definition at line 139 of file Penalties.h.

Simulated::Simulated ( const Simulated sim) [inline]

This copy constructor should be unnecessary. It's included in the event end-users feel like getting funky.

Parameters:
simThe Simulated object to be copied

Definition at line 147 of file Penalties.h.

virtual Simulated::~Simulated ( ) [inline, virtual]

A no-op destructor.

This destructor has been virtualized in case end-users wish to subclass.

Definition at line 154 of file Penalties.h.


Member Function Documentation

ReturnType Simulated::operator() ( const int  ) const [inline]

All PenaltyFuncs must implement operator()(const int iter).

However, for simulated annealing a constant value is always returned.

Definition at line 171 of file Penalties.h.

void Simulated::setMultiplier ( const double  multiplier) [inline]

Sets the multiplier for use in simulated annealing.

Parameters:
multiplierThe multiplier to use

Definition at line 161 of file Penalties.h.


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