ganesh 0.27.1

Minimization and sampling in Rust, simplified
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use crate::{
    algorithms::particles::{Swarm, SwarmPositionInitializer},
    core::Point,
    traits::{ProgressStatus, Status, StatusMessage},
    DVector, Float,
};
use serde::{Deserialize, Serialize};
use std::ops::ControlFlow;

/// A status for particle swarm optimization and similar methods.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct SwarmStatus {
    /// The global best position found by all particles
    pub gbest: Point<DVector<Float>>,
    /// The global best position among the initial swarm before any updates.
    pub initial_gbest: Point<DVector<Float>>,
    /// A message containing information about the condition of the swarm or convergence
    pub message: StatusMessage,
    /// The swarm
    pub swarm: Swarm,
    /// The number of function evaluations (approximately, this is left up to individual
    /// [`Algorithm`](crate::traits::Algorithm)s to correctly compute and may not be exact).
    pub n_f_evals: usize,
}
impl Default for SwarmStatus {
    fn default() -> Self {
        Self {
            gbest: Default::default(),
            initial_gbest: Default::default(),
            message: Default::default(),
            swarm: Swarm::new(SwarmPositionInitializer::Custom(Vec::default())),
            n_f_evals: Default::default(),
        }
    }
}

impl Status for SwarmStatus {
    fn reset(&mut self) {
        self.gbest = Default::default();
        self.initial_gbest = Default::default();
        self.message = Default::default();
        self.swarm.particles = Default::default();
        self.n_f_evals = Default::default();
    }

    fn message(&self) -> &StatusMessage {
        &self.message
    }

    fn set_message(&mut self) -> &mut StatusMessage {
        &mut self.message
    }

    fn check_invariants(&mut self) -> ControlFlow<()> {
        let invalid_global_best = self.gbest.fx.is_some_and(|fx| !fx.is_finite())
            || self.initial_gbest.fx.is_some_and(|fx| !fx.is_finite());
        let invalid_particle_best = self
            .swarm
            .particles
            .iter()
            .any(|particle| particle.best.fx.is_some_and(|fx| !fx.is_finite()));

        if invalid_global_best || invalid_particle_best {
            self.set_message().fail_with_message("f(x) is not finite");
            return ControlFlow::Break(());
        }
        ControlFlow::Continue(())
    }
}

impl ProgressStatus for SwarmStatus {
    fn write_progress(&self, out: &mut String) -> std::fmt::Result {
        use std::fmt::Write;
        write!(
            out,
            "status={} gbest_fx={} n_f_evals={}",
            self.message,
            self.gbest.fx.unwrap_or(Float::NAN),
            self.n_f_evals
        )
    }
}