Skip to main content

FireflyAlgorithm

Struct FireflyAlgorithm 

Source
pub struct FireflyAlgorithm<B: Backend> { /* private fields */ }
Expand description

Firefly Algorithm strategy.

When the custom-kernels feature is off, FireflyConfig enforces a pop_size <= FIREFLY_PURE_TENSOR_CAP (= 128) cap through Validate::validate at the harness chokepoint, since the pure-tensor path materializes an (N, N, D) pairwise tensor. With the feature on the same cap is surfaced via a debug_assert! in Strategy::init, because the fused kernel super::kernels::pairwise_attract_cube is still designed-only and the strategy keeps using the pure-tensor path in the meantime.

§Example

use burn::backend::Flex;
use rlevo_evolution::algorithms::metaheuristic::firefly::{FireflyAlgorithm, FireflyConfig};

let strategy = FireflyAlgorithm::<Flex>::new();
let params = FireflyConfig::default_for(32, 10);
let _ = (strategy, params);

Implementations§

Source§

impl<B: Backend> FireflyAlgorithm<B>

Source

pub fn new() -> Self

Builds a new (stateless) strategy object.

Trait Implementations§

Source§

impl<B: Clone + Backend> Clone for FireflyAlgorithm<B>

Source§

fn clone(&self) -> FireflyAlgorithm<B>

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<B: Copy + Backend> Copy for FireflyAlgorithm<B>

Source§

impl<B: Debug + Backend> Debug for FireflyAlgorithm<B>

Source§

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

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

impl<B: Default + Backend> Default for FireflyAlgorithm<B>

Source§

fn default() -> FireflyAlgorithm<B>

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

impl<B: Backend> Strategy<B> for FireflyAlgorithm<B>
where B::Device: Clone,

Source§

fn init( &self, params: &FireflyConfig, rng: &mut dyn Rng, device: &<B as BackendTypes>::Device, ) -> FireflyState<B>

Build the initial swarm by host-sampling pop_size positions uniformly in [bounds.lo, bounds.hi].

Positions are drawn from a deterministic seed_stream so initialisation is bit-stable regardless of core count or test ordering; the process-wide Flex RNG is never touched.

The pop_size <= FIREFLY_PURE_TENSOR_CAP cap (without custom-kernels) is enforced by FireflyConfig’s Validate impl at the harness chokepoint.

Source§

fn ask( &self, params: &FireflyConfig, state: &FireflyState<B>, rng: &mut dyn Rng, device: &<B as BackendTypes>::Device, ) -> (Tensor<B, 2>, FireflyState<B>)

Propose the next swarm positions.

On the first call (state.fitness is empty) returns the initial positions unchanged so the caller can evaluate generation zero. On subsequent calls, computes the pairwise attractiveness update via pure_tensor_attract and clips positions to params.bounds. The noise seed is derived from the host RNG through seed_stream, keeping draws reproducible.

Source§

fn tell( &self, _params: &FireflyConfig, population: Tensor<B, 2>, fitness: Tensor<B, 1>, state: FireflyState<B>, _rng: &mut dyn Rng, ) -> (FireflyState<B>, StrategyMetrics)

Ingest fitness values, update the swarm, and advance the generation counter.

Pulls fitness to host, updates state.positions and state.fitness, then refreshes the best-so-far genome if the current generation contains a new maximum. Returns the updated state and a StrategyMetrics snapshot for the completed generation.

Source§

fn best(&self, state: &FireflyState<B>) -> Option<(Tensor<B, 2>, f32)>

Returns the best-so-far (genome, fitness) pair, or None before the first tell call.

Source§

type Params = FireflyConfig

Static parameters for a run.
Source§

type State = FireflyState<B>

Generation-to-generation state.
Source§

type Genome = Tensor<B, 2>

Genome container produced by ask.

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