capra-core 0.4.1

Diver compression library
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

use crate::deco::zhl16::*;
use crate::deco::TISSUE_COUNT;

#[derive(Copy, Clone, Debug)]
#[cfg_attr(feature = "use-serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TissueConstants {
    /// Nitrogen A-values.
    pub(crate) n2_a: [f64; TISSUE_COUNT],
    /// Nitrogen B-values.
    pub(crate) n2_b: [f64; TISSUE_COUNT],
    /// Nitrogen half-lives.
    pub(crate) n2_hl: [f64; TISSUE_COUNT],
    /// Helium A-values.
    pub(crate) he_a: [f64; TISSUE_COUNT],
    /// Helium B-values.
    pub(crate) he_b: [f64; TISSUE_COUNT],
    /// Helium half-lives.
    pub(crate) he_hl: [f64; TISSUE_COUNT],
}

impl TissueConstants {
    /// Returns a ZHL16 model with the given parameters.
    /// Use this if you have to supply all the tissue loading constants by yourself. Otherwise, use `new_by_variant` instead.
    pub fn new(
        n2_a: [f64; TISSUE_COUNT],
        n2_b: [f64; TISSUE_COUNT],
        n2_hl: [f64; TISSUE_COUNT],
        he_a: [f64; TISSUE_COUNT],
        he_b: [f64; TISSUE_COUNT],
        he_hl: [f64; TISSUE_COUNT],
    ) -> Self {
        Self {
            n2_a,
            n2_b,
            n2_hl,
            he_a,
            he_b,
            he_hl,
        }
    }

    /// Returns a `TissueConstant` with the tissue loading constants of a defined variant.
    /// # Arguments
    /// * `variant` - Variant to use
    pub fn new_by_variant(variant: Variant) -> Self {
        match variant {
            Variant::B => Self::new(
                ZHL16B_N2_A,
                ZHL16B_N2_B,
                ZHL16B_N2_HALFLIFE,
                ZHL16B_HE_A,
                ZHL16B_HE_B,
                ZHL16B_HE_HALFLIFE,
            ),
            Variant::C => Self::new(
                ZHL16C_N2_A,
                ZHL16C_N2_B,
                ZHL16C_N2_HALFLIFE,
                ZHL16C_HE_A,
                ZHL16C_HE_B,
                ZHL16C_HE_HALFLIFE,
            ),
        }
    }
}