markovian 0.2.1

Simulation of Markov Processes as stochastic processes.
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

use crate::errors::InvalidState;

/// Possible public state.
/// 
/// `State` should be implemented when it is absolutely clear what a `state` for your your struct means.
pub trait State {
    type Item: core::fmt::Debug;

    #[inline]
    fn state(&self) -> Option<&Self::Item> {
        None
    }

    #[inline]
    fn state_mut(&mut self) -> Option<&mut Self::Item> {
        None
    }

    /// # Remarks
    ///
    /// You might want to use [core::mem::swap](https://doc.rust-lang.org/core/mem/fn.swap.html).
    #[inline]
    fn set_state(
        &mut self,
        new_state: Self::Item,
    ) -> Result<Option<Self::Item>, InvalidState<Self::Item>> {
        Err(InvalidState::new(new_state))
    }
}