turboswarm-core 0.7.0

Particle Swarm Optimization core: extensible and modular
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! Swarm data structures.

/// A particle. All positions/velocities are internal `Vec<f64>`
/// (see the note in `traits.rs`).
#[derive(Debug, Clone)]
pub struct Particle {
    /// Current position (internal continuous representation).
    pub position: Vec<f64>,
    /// Current velocity.
    pub velocity: Vec<f64>,
    /// Best position visited by this particle (its `pbest`).
    pub best_position: Vec<f64>,
    /// Objective function value at `best_position`.
    pub best_value: f64,
}

impl Particle {
    /// Creates a particle, initializing its `pbest` with the given position.
    pub fn new(position: Vec<f64>, velocity: Vec<f64>, value: f64) -> Self {
        Self {
            best_position: position.clone(),
            best_value: value,
            position,
            velocity,
        }
    }
}

/// The complete swarm. The `Topology` receives it to decide neighborhoods.
#[derive(Debug, Clone)]
pub struct Swarm {
    /// The particles that make up the swarm.
    pub particles: Vec<Particle>,
}

impl Swarm {
    /// Creates a swarm from its particles.
    pub fn new(particles: Vec<Particle>) -> Self {
        Self { particles }
    }

    /// Number of particles in the swarm.
    pub fn len(&self) -> usize {
        self.particles.len()
    }

    /// `true` if the swarm has no particles.
    pub fn is_empty(&self) -> bool {
        self.particles.is_empty()
    }
}