exdsdevs 1.1.0

A Rust library for for developing discrete-event models based on DEVS formalism.
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

// Copyright 2023 Developers of the exdsdevs project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms

/// Model behavior definition module
use std::fmt::Debug;

use dyn_clone::DynClone;
use rand::rngs::StdRng;

use crate::{
    containers::{Bag, Mail, Outputs, Value},
    time::Time,
};

impl Debug for Box<dyn Dynamic> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let val = self.state();
        Debug::fmt(&val, f)
    }
}

impl Default for Box<dyn Dynamic> {
    fn default() -> Self {
        Box::new(DefaultDynamic)
    }
}

/// Trait defining DEVS component behavior
/// # Implementation Example
/// ```
/// #[derive(Clone)]
/// struct MyDynamic {
///     state: u32,
/// }
///
/// impl Dynamic for MyDynamic {
///     fn time_advance(&self) -> Time {
///         Time::Value(1)
///     }
///
///     fn internal_transition(&mut self) {
///         self.state += 1;
///     }
/// }
/// ```
#[allow(unused_variables)]
pub trait Dynamic: DynClone + Send {
    /// Model initialization
    fn init(&mut self, init_time: Time, rng: &mut StdRng) {}

    /// Internal state transition
    fn internal_transition(&mut self, sim_time: Time, rng: &mut StdRng) {}

    /// External state transition
    fn external_transition(
        &mut self,
        sim_time: Time,
        elapsed: Time,
        x_bag: &Bag,
        rng: &mut StdRng,
    ) {
    }

    fn external_mail_transition(
        &mut self,
        sim_time: Time,
        elapsed: Time,
        mail: &Mail,
        rng: &mut StdRng,
    ) {
    }

    /// # Variants:
    /// ```
    /// self.internal_transition(sim_time, rng);
    /// self.external_transition(sim_time, Time::Value(0), x_bag, rng);
    ///```
    ///
    /// or:
    ///```
    /// self.external_transition(sim_time, Time::Value(0), x_bag, rng);
    /// self.internal_transition(sim_time, rng);
    ///```
    fn confluent_transition(&mut self, sim_time: Time, x_bag: &Bag, rng: &mut StdRng) {
        unimplemented!("Simulation reaches confluent_transition, but it is not implemented!")
    }

    /// Output message generation
    fn output(&self, sim_time: Time, outputs: &mut Outputs) {}

    /// Time to next internal event
    fn time_advance(&self, rng: &mut StdRng) -> Time;

    fn state(&self) -> Value;

    fn finish(&self, sim_time: Time) {}
}

impl Clone for Box<dyn Dynamic> {
    fn clone(&self) -> Self {
        dyn_clone::clone_box(&**self)
    }
}

#[derive(Clone)]
pub struct DefaultDynamic;

impl Dynamic for DefaultDynamic {
    fn time_advance(&self, _: &mut StdRng) -> Time {
        Time::Inf
    }

    fn state(&self) -> Value {
        Value::Null
    }
}