Skip to main content

PsoConfig

Struct PsoConfig 

Source
pub struct PsoConfig {
    pub pop_size: usize,
    pub genome_dim: usize,
    pub bounds: Bounds,
    pub inertia: f32,
    pub c1: f32,
    pub c2: f32,
    pub v_max: f32,
    pub variant: PsoVariant,
}
Expand description

Static configuration for a ParticleSwarm run.

Fields§

§pop_size: usize

Number of particles in the swarm.

§genome_dim: usize

Genome (position) dimensionality.

§bounds: Bounds

Search-space bounds for initialization and position clamping.

§inertia: f32

Inertia weight (only used by PsoVariant::Inertia).

§c1: f32

Cognitive coefficient (personal-best pull).

§c2: f32

Social coefficient (global-best pull).

§v_max: f32

Per-dimension velocity clamp. Classical PSO literature recommends ~half the search-space extent.

§variant: PsoVariant

Variant.

Implementations§

Source§

impl PsoConfig

Source

pub fn default_for(pop_size: usize, genome_dim: usize) -> Self

Default configuration matching Shi & Eberhart’s canonical settings (ω = 0.7298, c1 = c2 = 1.49618) — the constriction-equivalent values so Inertia and Constriction variants agree in behaviour under the same default.

The default variant is PsoVariant::Inertia. To switch to the constriction form, set variant = PsoVariant::Constriction and update c1 and c2 so that c1 + c2 > 4 (the Clerc & Kennedy requirement — the default c1 = c2 = 1.49618 gives φ ≈ 2.99, which violates this); a canonical choice is c1 = c2 = 2.05.

Source

pub fn constriction_chi(&self) -> f32

Computes the constriction factor χ = 2 / |2 − φ − √(φ² − 4φ)| where φ = c1 + c2.

Clerc & Kennedy (2002) require φ > 4 for the closed form to be real-valued. If φ ≤ 4 the discriminant is clamped to zero and χ falls back to 1.0 (no contraction) so the strategy remains numerically well-defined. A debug_assert! fires in debug builds when this fallback is triggered; it is silent in release builds.

Trait Implementations§

Source§

impl Clone for PsoConfig

Source§

fn clone(&self) -> PsoConfig

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 Debug for PsoConfig

Source§

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

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

impl Validate for PsoConfig

Source§

fn validate(&self) -> Result<(), ConfigError>

Returns Ok(()) when every invariant holds, or the first ConfigError otherwise. Read more
Source§

fn validate_all(&self) -> Result<(), Vec<ConfigError>>

Returns every violated invariant rather than just the first. Read more

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