Struct argmin::solver::simulatedannealing::SimulatedAnnealing

pub struct SimulatedAnnealing<F> { /* fields omitted */ }

Simulated Annealing

Example

References

[0] Wikipedia

[1] S Kirkpatrick, CD Gelatt Jr, MP Vecchi. (1983). “Optimization by Simulated Annealing”. Science 13 May 1983, Vol. 220, Issue 4598, pp. 671-680 DOI: 10.1126/science.220.4598.671

Implementations

impl<F> SimulatedAnnealing<F> where
    F: ArgminFloat, 

pub fn new(init_temp: F) -> Result<Self, Error>

Constructor

Parameter:

• init_temp: initial temperature

pub fn temp_func(self, temperature_func: SATempFunc<F>) -> Self

Set temperature function to one of the options in SATempFunc.

pub fn stall_accepted(self, iter: u64) -> Self

The optimization stops after there has been no accepted solution after iter iterations

pub fn stall_best(self, iter: u64) -> Self

The optimization stops after there has been no new best solution after iter iterations

pub fn reannealing_fixed(self, iter: u64) -> Self

Start reannealing after iter iterations

pub fn reannealing_accepted(self, iter: u64) -> Self

Start reannealing after no accepted solution has been found for iter iterations

pub fn reannealing_best(self, iter: u64) -> Self

Start reannealing after no new best solution has been found for iter iterations

Trait Implementations

impl<F: Clone> Clone for SimulatedAnnealing<F>

fn clone(&self) -> SimulatedAnnealing<F>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de, F> Deserialize<'de> for SimulatedAnnealing<F> where
    F: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<F> Serialize for SimulatedAnnealing<F> where
    F: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<O, F> Solver<O> for SimulatedAnnealing<F> where
    O: ArgminOp<Output = F, Float = F>,
    F: ArgminFloat, 

const NAME: &'static str

Name of the solver

fn init(
    &mut self,
    _op: &mut OpWrapper<O>,
    _state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm

fn next_iter(
    &mut self,
    op: &mut OpWrapper<O>,
    state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>

Perform one iteration of SA algorithm

fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply.