infojenn 0.1.4

Compute information content of ontology terms from corpora of annotated items
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

#![doc = include_str!("../README.md")]

use std::cmp::Ordering;

use ontolius::TermId;

#[cfg(test)]
mod model;
#[cfg(test)]
mod subjects;

pub mod ic;

/// A pair of [`TermId`]s.
///
/// The term ids are maintained in a stable order
/// where *"left"* is always less than or equal to *"right"*.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TermPair {
    left: TermId,
    right: TermId,
}

impl TermPair {
    /// Get the *"left"* term ID.
    pub fn left(&self) -> &TermId {
        &self.left
    }

    /// Get the *"right"* term ID.
    pub fn right(&self) -> &TermId {
        &self.right
    }
}

/// Create a pair from a term ID tuple.
///
/// ## Example
///
/// Create a term pair:
///
/// ```
/// use ontolius::TermId;
/// use infojenn::TermPair;
///
/// let left = TermId::from(("HP", "0000118"));
/// let right = TermId::from(("HP", "0001250"));
///
/// let tp = TermPair::from((left, right));
/// ```
///
/// The order of the arguments does not matter:
///
/// ```
/// # use ontolius::TermId;
/// # use infojenn::TermPair;
/// let left = TermId::from(("HP", "0000118"));
/// let right = TermId::from(("HP", "0001250"));
///
/// let lr = TermPair::from((left.clone(), right.clone()));
/// let rl = TermPair::from((right, left));
///
/// assert_eq!(lr, rl);
/// ```
impl From<(TermId, TermId)> for TermPair {
    fn from(value: (TermId, TermId)) -> Self {
        match value.0.cmp(&value.1) {
            Ordering::Less | Ordering::Equal => Self {
                left: value.0,
                right: value.1,
            },
            Ordering::Greater => Self {
                left: value.1,
                right: value.0,
            },
        }
    }
}

/// Create a term pair by cloning [`TermId`] references.
impl<'a> From<(&'a TermId, &'a TermId)> for TermPair {
    fn from(value: (&'a TermId, &'a TermId)) -> Self {
        Self::from((value.0.clone(), value.1.clone()))
    }
}

/// Create a pair representing a single [`TermId`].
impl From<TermId> for TermPair {
    fn from(value: TermId) -> Self {
        Self {
            left: Clone::clone(&value),
            right: value,
        }
    }
}