lib_rapid 0.7.0

LibRapid - a library specifically built for mathematical calculations and scientific applications.
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

//! Definition of a chemical element and constants (in pse).
pub mod pse;
/// The struct for storing a chemical element.
#[derive(Debug, Clone, Copy, Default, PartialEq)]
pub struct Element<'a> {
    pub symbol:           &'a str,
    pub protons:          u8,
    pub electrons:        u8,
    pub neutrons:         u8,
    pub atomic_weight:    f32,
    pub pauling_en:       f32
}

impl<'a> Element<'a> {
    /// Create a new, custom chemical element.
    /// # Arguments
    /// * `symbol: &str` - The element symbol.
    /// * `protons: u8` - The number of protons.
    /// * `electrons: u8` - The number of electrons.
    /// * `neutrons: u8` - The number of neutrons.
    /// * `atomic_weight: f32` - The weighted average of all isotopes.
    /// * `pauling_en: f32` - The electronegativity after Pauling.
    /// # Examples
    /// ```
    /// use lib_rapid::chem::elements::Element;
    /// 
    /// let elem = Element::new("Xy", 255, 255, 255, 510.7, 6.54); // Fictional element.
    /// assert_eq!(elem.atomic_weight, 510.7);
    /// ```
    pub const fn new(symbol:           &str,
                     protons:          u8,
                     electrons:        u8,
                     neutrons:         u8,
                     atomic_weight:    f32,
                     pauling_en:       f32) -> Element {
        Element { symbol, protons, electrons, neutrons, atomic_weight, pauling_en }
    }
    /// Lets you get the mass number of a direct element.
    /// # Examples
    /// ```
    /// use lib_rapid::chem::elements::Element;
    /// 
    /// let elem = Element::new("Xy", 255, 255, 255, 510.7, 6.54); // Fictional element.
    /// assert_eq!(elem.mass_number(), 510);
    /// ```
    pub const fn mass_number(&self) -> u16 {
        self.protons as u16 + self.neutrons as u16
    }
}