Struct argmin::solver::simulatedannealing::SimulatedAnnealing

pub struct SimulatedAnnealing<F, R> { /* private fields */ }

Simulated Annealing

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, R> SimulatedAnnealing<F, R> where
    F: ArgminFloat, 

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

Constructor

Parameter:

• init_temp: initial temperature
• rng: an RNG (must implement Serialize when serde1 feature is activated)

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, R: Clone> Clone for SimulatedAnnealing<F, R>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, F, R> Deserialize<'de> for SimulatedAnnealing<F, R> where
    F: Deserialize<'de>,
    R: 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, R> Serialize for SimulatedAnnealing<F, R> where
    F: Serialize,
    R: 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, P, F, R> Solver<O, IterState<P, (), (), (), F>> for SimulatedAnnealing<F, R> where
    O: CostFunction<Param = P, Output = F> + Anneal<Param = P, Output = P, Float = F>,
    P: Clone,
    F: ArgminFloat,
    R: Rng + SerializeAlias, 

fn next_iter(
    &mut self,
    problem: &mut Problem<O>,
    state: IterState<P, (), (), (), F>
) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>

Perform one iteration of SA algorithm

const NAME: &'static str

Name of the solver. Mainly used in Observers.

fn init(
    &mut self,
    problem: &mut Problem<O>,
    state: IterState<P, (), (), (), F>
) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>

Initializes the algorithm.

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

Used to implement stopping criteria, in particular criteria which are not covered by (terminate_internal.

fn terminate_internal(&mut self, state: &I) -> TerminationReason

Checks whether basic termination reasons apply.