Struct argmin::solver::simulatedannealing::SimulatedAnnealing
source · [−]pub struct SimulatedAnnealing<F, R> { /* private fields */ }
Expand description
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
sourceimpl<F, R> SimulatedAnnealing<F, R> where
F: ArgminFloat,
impl<F, R> SimulatedAnnealing<F, R> where
F: ArgminFloat,
sourcepub fn new(init_temp: F, rng: R) -> Result<Self, Error>
pub fn new(init_temp: F, rng: R) -> Result<Self, Error>
Constructor
Parameter:
init_temp
: initial temperaturerng
: an RNG (must implement Serialize whenserde1
feature is activated)
sourcepub fn temp_func(self, temperature_func: SATempFunc<F>) -> Self
pub fn temp_func(self, temperature_func: SATempFunc<F>) -> Self
Set temperature function to one of the options in SATempFunc
.
sourcepub fn stall_accepted(self, iter: u64) -> Self
pub fn stall_accepted(self, iter: u64) -> Self
The optimization stops after there has been no accepted solution after iter
iterations
sourcepub fn stall_best(self, iter: u64) -> Self
pub fn stall_best(self, iter: u64) -> Self
The optimization stops after there has been no new best solution after iter
iterations
sourcepub fn reannealing_fixed(self, iter: u64) -> Self
pub fn reannealing_fixed(self, iter: u64) -> Self
Start reannealing after iter
iterations
sourcepub fn reannealing_accepted(self, iter: u64) -> Self
pub fn reannealing_accepted(self, iter: u64) -> Self
Start reannealing after no accepted solution has been found for iter
iterations
sourcepub fn reannealing_best(self, iter: u64) -> Self
pub fn reannealing_best(self, iter: u64) -> Self
Start reannealing after no new best solution has been found for iter
iterations
Trait Implementations
sourceimpl<F: Clone, R: Clone> Clone for SimulatedAnnealing<F, R>
impl<F: Clone, R: Clone> Clone for SimulatedAnnealing<F, R>
sourcefn clone(&self) -> SimulatedAnnealing<F, R>
fn clone(&self) -> SimulatedAnnealing<F, R>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'de, F, R> Deserialize<'de> for SimulatedAnnealing<F, R> where
F: Deserialize<'de>,
R: Deserialize<'de>,
impl<'de, F, R> Deserialize<'de> for SimulatedAnnealing<F, R> where
F: Deserialize<'de>,
R: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<F, R> Serialize for SimulatedAnnealing<F, R> where
F: Serialize,
R: Serialize,
impl<F, R> Serialize for SimulatedAnnealing<F, R> where
F: Serialize,
R: Serialize,
sourceimpl<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,
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,
sourcefn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, (), (), (), F>
) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>
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
sourcefn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, (), (), (), F>
) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>
fn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, (), (), (), F>
) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>
Initializes the algorithm. Read more
sourcefn terminate(
&mut self,
_state: &IterState<P, (), (), (), F>
) -> TerminationReason
fn terminate(
&mut self,
_state: &IterState<P, (), (), (), F>
) -> TerminationReason
Used to implement stopping criteria, in particular criteria which are not covered by
(terminate_internal
. Read more
sourcefn terminate_internal(&mut self, state: &I) -> TerminationReason
fn terminate_internal(&mut self, state: &I) -> TerminationReason
Checks whether basic termination reasons apply. Read more
Auto Trait Implementations
impl<F, R> RefUnwindSafe for SimulatedAnnealing<F, R> where
F: RefUnwindSafe,
R: RefUnwindSafe,
impl<F, R> Send for SimulatedAnnealing<F, R> where
F: Send,
R: Send,
impl<F, R> Sync for SimulatedAnnealing<F, R> where
F: Sync,
R: Sync,
impl<F, R> Unpin for SimulatedAnnealing<F, R> where
F: Unpin,
R: Unpin,
impl<F, R> UnwindSafe for SimulatedAnnealing<F, R> where
F: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more