optlib 0.4.0

The optimization algorithms realized in Rust. In given time realized genetic and particle swarm algorithms.
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
83
84
85
86

use num::{NumCast, Zero};

use crate::tools::RandomVectorCreator;
use crate::particleswarm::{CoordinatesInitializer, VelocityInitializer};

/// The struct to initialize particles coordinates with random value from given intervals.
pub struct RandomCoordinatesInitializer<T> {
    // Intervals for every dimension. Size of the vector must be equal to dimension.
    // The first value in tuple is minimum value, the second value is maximum value.
    intervals: Vec<(T, T)>,
    particles_count: usize,
    vector_creator: RandomVectorCreator,
}

impl<T> RandomCoordinatesInitializer<T> {
    /// Constructor.
    ///
    /// # Parameters
    /// `intervals` - vector of tuples. Size of the vector must be equal to dimension. The first value in tuple is minimum coordinate, the second value is maximum coordinate.
    /// `particles_count` - how many particles do you need to create.
    pub fn new(intervals: Vec<(T, T)>, particles_count: usize) -> Self {
        Self {
            intervals,
            particles_count,
            vector_creator: RandomVectorCreator::new(),
        }
    }
}

impl<T: NumCast + PartialOrd> CoordinatesInitializer<T> for RandomCoordinatesInitializer<T> {
    fn get_coordinates(&mut self) -> Vec<Vec<T>> {
        (0..self.particles_count)
            .map(|_| self.vector_creator.create_vec(&self.intervals))
            .collect()
    }
}

/// The struct to initialze particles velocity with random velocity
pub struct RandomVelocityInitializer<T> {
    intervals: Vec<(T, T)>,
    particles_count: usize,
    vector_creator: RandomVectorCreator,
}

impl<T> RandomVelocityInitializer<T> {
    /// Constructor.
    ///
    /// # Parameters
    /// `intervals` - vector of tuples. Size of the vector must be equal to dimension. The first value in tuple is minimum velocity, the second value is maximum seed.
    /// `particles_count` - how many particles do you need to create.
    pub fn new(intervals: Vec<(T, T)>, particles_count: usize) -> Self {
        Self {
            intervals,
            particles_count,
            vector_creator: RandomVectorCreator::new(),
        }
    }
}

impl<T: NumCast + PartialOrd> VelocityInitializer<T> for RandomVelocityInitializer<T> {
    fn get_velocity(&mut self) -> Vec<Vec<T>> {
        (0..self.particles_count)
            .map(|_| self.vector_creator.create_vec(&self.intervals))
            .collect()
    }
}

/// The struct to initialize particles velocity with zeros.
pub struct ZeroVelocityInitializer {
    dimension: usize,
    particles_count: usize,
}

impl ZeroVelocityInitializer {
    pub fn new(dimension: usize, particles_count: usize) -> Self {
        Self { dimension, particles_count }
    }
}

impl<T: NumCast + PartialOrd + Zero + Clone> VelocityInitializer<T> for ZeroVelocityInitializer {
    fn get_velocity(&mut self) -> Vec<Vec<T>> {
        (0..self.particles_count)
            .map(|_| vec![T::zero(); self.dimension])
            .collect()
    }
}