hexga_generational 0.0.11-beta.48

GenVec, ideal for MAS (Multi-Agent System), where each agent can be removed at any time and has references to other agents.
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use super::*;

pub mod prelude
{
    pub use super::GenID;
    pub(crate) use super::{GenIDOf, Generation, IGeneration};
}

pub trait IGeneration:
    Eq
    + Hash
    + Ord
    + Increment
    + Decrement
    + OverflowBehavior
    + Debug
    + MaxValue
    + MinValue
    + Copy
    + 'static
{
}
impl<T> IGeneration for T where
    T: Eq
        + Hash
        + Ord
        + Increment
        + Decrement
        + OverflowBehavior
        + Debug
        + MaxValue
        + MinValue
        + Copy
        + 'static
{
}

// Todo: Make a flag for the generation
pub type Generation = u32;
pub type GenID = GenIDOf<Generation>;

#[derive(Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub struct GenIDOf<Gen: IGeneration = Generation>
{
    index: usize,
    generation: Gen,
}

impl<Gen: IGeneration> Default for GenIDOf<Gen>
{
    fn default() -> Self { Self::NULL }
}

#[cfg(feature = "serde")]
impl<Gen: IGeneration> Serialize for GenIDOf<Gen>
where
    Gen: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        if self.index.is_max()
        {
            None
        }
        else
        {
            Some((self.index, self.generation))
        }
        .serialize(serializer)
    }
}

#[cfg(feature = "serde")]
impl<'de, Gen: IGeneration> Deserialize<'de> for GenIDOf<Gen>
where
    Gen: Deserialize<'de>,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        match Option::deserialize(deserializer)?
        {
            Some((index, generation)) => Ok(Self::from_index_and_generation(index, generation)),
            None => Ok(Self::from_index_and_generation(usize::MAX, Gen::MIN)),
        }
    }
}
impl<Gen: IGeneration> Debug for GenIDOf<Gen>
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result
    {
        if self.is_null()
        {
            write!(f, "NULL")
        }
        else
        {
            f.debug_tuple("")
                .field(&self.index)
                .field(&GenerationDebug(self.generation))
                .finish()
        }
    }
}

pub(crate) struct GenerationDebug<T>(pub(crate) T);
impl<T> Debug for GenerationDebug<T>
where
    T: Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { write!(f, "#{:?}", self.0) }
}

// Todo: add GetManyMut ?
//pub trait CollectionWithGenVecID<T,Gen:IGeneration> : Get<GenIDOf<Gen>,Output=T> + GetMut<GenIDOf<Gen>,Output=T> + Remove<GenIDOf<Gen>,Output = T> {}
//impl<T,Gen:IGeneration,S> CollectionWithGenVecID<T,Gen> for S where S: Get<GenIDOf<Gen>,Output=T> + GetMut<GenIDOf<Gen>,Output=T> + Remove<GenIDOf<Gen>,Output = T> {}

impl<Gen: IGeneration> GenIDOf<Gen>
{
    pub const fn from_index_and_generation(index: usize, generation: Gen) -> Self
    {
        Self { index, generation }
    }

    pub const fn index(self) -> usize { self.index }
    pub const fn generation(self) -> Gen { self.generation }

    pub fn is_null(self) -> bool { self == Self::NULL }
    pub fn is_not_null(self) -> bool { self != Self::NULL }

    /// Set the value to `Self::NULL`
    pub fn reset(&mut self) { *self = Self::NULL; }

    pub const NULL: Self = GenIDOf {
        index: usize::MAX,
        generation: Gen::MIN,
    };
}
impl<Gen: IGeneration, C> IndexExtension<C> for GenIDOf<Gen> {}

impl<Gen: IGeneration> From<(usize, Gen)> for GenIDOf<Gen>
{
    fn from((index, generation): (usize, Gen)) -> Self
    {
        Self::from_index_and_generation(index, generation)
    }
}
impl<Gen: IGeneration> Into<(usize, Gen)> for GenIDOf<Gen>
{
    fn into(self) -> (usize, Gen) { (self.index, self.generation) }
}