swarmkit 0.1.0

Composable particle swarm optimization with nested searches
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

//! [`Floats<N>`] — element-wise `[f64; N]` newtype usable as a particle
//! [`crate::Unit`] without further boilerplate.

use crate::FieldwiseClamp;
use std::array::from_fn;
use std::ops::{Add, Index, IndexMut, Mul, Sub};

/// Element-wise newtype over `[f64; N]`.
///
/// Implements [`Add`], [`Sub`], [`Mul<f64>`], and [`FieldwiseClamp`] —
/// the minimum the standard PSO mover needs — plus [`Index`] /
/// [`IndexMut`] for `floats[i]` access. Inherits [`Copy`] / [`Default`]
/// / [`Debug`] from the underlying array, so it slots straight in as a
/// particle [`crate::Unit`].
///
/// The inner field is `pub`; bulk operations go through `.0`. Users who
/// want different element-wise semantics (saturating, modular, integer,
/// scalar-generic) define their own newtype around `[T; N]`.
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Floats<const N: usize>(pub [f64; N]);

impl<const N: usize> Default for Floats<N> {
    fn default() -> Self {
        Self([0.0; N])
    }
}

impl<const N: usize> Index<usize> for Floats<N> {
    type Output = f64;
    fn index(&self, i: usize) -> &f64 {
        &self.0[i]
    }
}

impl<const N: usize> IndexMut<usize> for Floats<N> {
    fn index_mut(&mut self, i: usize) -> &mut f64 {
        &mut self.0[i]
    }
}

impl<const N: usize> FieldwiseClamp for Floats<N> {
    fn clamp(&self, min: Self, max: Self) -> Self {
        Self(from_fn(|i| self.0[i].clamp(min.0[i], max.0[i])))
    }
}

impl<const N: usize> Add for Floats<N> {
    type Output = Self;
    fn add(self, rhs: Self) -> Self {
        Self(from_fn(|i| self.0[i] + rhs.0[i]))
    }
}

impl<const N: usize> Sub for Floats<N> {
    type Output = Self;
    fn sub(self, rhs: Self) -> Self {
        Self(from_fn(|i| self.0[i] - rhs.0[i]))
    }
}

impl<const N: usize> Mul<f64> for Floats<N> {
    type Output = Self;
    fn mul(self, rhs: f64) -> Self {
        Self(from_fn(|i| self.0[i] * rhs))
    }
}