An easy-to-use, simple Particle Swarm Optimization (PSO) implementation in Rust.
It uses the rand
crate for random initialization, and the rayon
crate for parallel objective function computation.
The example below can get you started.
In order to use it on your own optimization problem, you will need to define an objective function as it is defined in the run function, and a Config
object. See the Notes section for more tips.
```rust use pso_rs::model::*;
// define objective function (Rosenbrock)
fn objectivefunction(p: &Particle, _flatdim: usize, _dimensions: &Vec
// define a termination condition fn terminate(fbest: f64) -> bool { fbest - (0.0) < 1e-4 }
let config = Config { dimensions: vec![2], bounds: (-5.0, 5.0), ..Config::default() };
// define maximum number of objective function computations let t_max = 10000;
match psors::run(config, objectivefunction) { Ok(mut pso) => { pso.run(tmax, terminate); let mut model = pso.model; println!("Model: {:?} ", model.getf_best()); } Err(e) => { eprintln!("Could not construct PSO: {}", e); } } ```
Even though you can have particles of any shape and size, as long as each item is f64
, pso_rs
represents each particle as a flat vector: Vec<f64>
.
This means that, for example, in order to find clusters of 20 molecules in 3D space that minimize the Lennard-Jones potential energy, you can define dimensions
as (20, 3):
rust
let config = Config {
dimensions: vec![20, 3],
bounds: (-5.0, 5.0),
..Config::default()
};
If you want, you can also create a custom reshape
function, like this one for molecule clusters below:
rust
fn reshape(particle: &Particle, particle_dims: &Vec<usize>) -> Vec<Vec<f64>> {
let mut reshaped_population = vec![];
let mut i = 0;
for _ in 0..particle_dims[0] {
let mut reshaped_particle = vec![];
for _ in 0..particle_dims[1] {
reshaped_particle.push(particle[i]);
i += 1;
}
reshaped_population.push(reshaped_particle);
}
reshaped_population
}
Then you can use that to reshape the particle at any point, for example to print the minimizer or to use in the objective function you have defined:
```rust // somewhere in main(), after running PSO as in the example: println!( "Best found minimizer: {:#?} ", reshape(&model.getxbest(), &model.config.dimensions) );
// used in the objective function
fn objectivefunction(p: &Particle, flatdim: usize, dimensions: &Vec
License: MIT