Skip to main content

SimulatedAnnealing

Struct SimulatedAnnealing 

Source
pub struct SimulatedAnnealing;
Expand description

Simulated-annealing local search.

A unit struct: all configuration lives in SimulatedAnnealingParams, so one instance can refine many genomes. See the module docs for the acceptance rule and the best-so-far tracking that upholds the LocalSearch contract.

§Example

use burn::backend::Flex;
use rand::{rngs::StdRng, SeedableRng};
use rlevo_evolution::fitness::FitnessFn;
use rlevo_core::bounds::Bounds;
use rlevo_evolution::local_search::{LocalSearch, SimulatedAnnealing, SimulatedAnnealingParams};

// Maximize the negated 2-D sphere; the optimum is the origin with fitness 0.
struct NegSphere;
impl FitnessFn<Vec<f32>> for NegSphere {
    fn evaluate_one(&mut self, x: &Vec<f32>) -> f32 {
        -x.iter().map(|v| v * v).sum::<f32>()
    }
}

let searcher = SimulatedAnnealing;
let params = SimulatedAnnealingParams::default_for(Bounds::new(-5.12, 5.12));
let mut fitness = NegSphere;
let mut rng = StdRng::seed_from_u64(7);

let start = vec![2.5_f32, -1.5];
let start_fit: f32 = -start.iter().map(|v| v * v).sum::<f32>();
let (refined, refined_fit) =
    LocalSearch::<Flex>::refine(&searcher, &params, start, &mut fitness, &mut rng);

assert_eq!(refined.len(), 2);          // dimensionality preserved
assert!(refined_fit >= start_fit);     // monotone non-worsening

Trait Implementations§

Source§

impl Clone for SimulatedAnnealing

Source§

fn clone(&self) -> SimulatedAnnealing

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SimulatedAnnealing

Source§

impl Debug for SimulatedAnnealing

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SimulatedAnnealing

Source§

fn default() -> SimulatedAnnealing

Returns the “default value” for a type. Read more
Source§

impl<B: Backend> LocalSearch<B> for SimulatedAnnealing

Source§

fn refine( &self, params: &SimulatedAnnealingParams, genome: Vec<f32>, fitness_fn: &mut dyn FitnessFn<Vec<f32>>, rng: &mut dyn Rng, ) -> (Vec<f32>, f32)

§Panics

Panics if params.max_iters == 0; see refine_impl.

Source§

fn refine_with_known_fitness( &self, params: &SimulatedAnnealingParams, genome: Vec<f32>, known_fitness: f32, fitness_fn: &mut dyn FitnessFn<Vec<f32>>, rng: &mut dyn Rng, ) -> (Vec<f32>, f32)

Seeds the walker and best-so-far tracker with known_fitness (sanitizing NaN to -inf) instead of re-scoring the input, saving one eval.

§Panics

Panics if params.max_iters == 0; see refine_impl.

Source§

type Params = SimulatedAnnealingParams

Static configuration for a refinement run (bounds, budget, step sizes, …). Cloned by a memetic wrapper once per generation.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

fn adapt(&self)

Adapt the type to be passed to a metric.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<C> CloneExpand for C
where C: Clone,

Source§

fn __expand_clone_method(&self, _scope: &mut Scope) -> C

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoComptime for T

Source§

fn comptime(self) -> Self

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> TuneInputs for T
where T: Clone + Send + Sync + 'static,

Source§

type At<'a> = T

The concrete input type at lifetime 'a.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more