mastishk 1.1.0

Mastishk — computational neuroscience: neurotransmitters, neural circuits, sleep stages, HPA axis, default mode network
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

//! Error types for mastishk.

use thiserror::Error;

/// Errors that can occur in neuroscience computations.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum MastishkError {
    /// Neurotransmitter level out of physiological range.
    #[error("neurotransmitter level out of range: {name} = {value} (expected {min}..={max})")]
    LevelOutOfRange {
        name: String,
        value: f32,
        min: f32,
        max: f32,
    },

    /// Invalid circuit configuration.
    #[error("invalid circuit: {0}")]
    InvalidCircuit(String),

    /// Sleep stage transition not valid.
    #[error("invalid sleep transition: {from:?} -> {to:?}")]
    InvalidSleepTransition { from: String, to: String },

    /// Negative time delta.
    #[error("negative time delta: {0}")]
    NegativeTimeDelta(f32),

    /// Invalid drug parameter.
    #[error("invalid drug parameter: {0}")]
    InvalidDrugParameter(String),
}

/// Validate that a time delta is non-negative.
#[inline]
pub(crate) fn validate_dt(dt: f32) -> Result<(), MastishkError> {
    if dt < 0.0 {
        Err(MastishkError::NegativeTimeDelta(dt))
    } else {
        Ok(())
    }
}