raphtory-api 0.17.0

Raphtory common interface and APIs
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::core::{
    entities::{EID, VID},
    storage::timeindex::{AsTime, EventTime},
};
use std::cmp::Ordering;

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct EdgeRef {
    e_pid: EID,
    src_pid: VID,
    dst_pid: VID,
    e_type: Dir,
    time: Option<EventTime>,
    layer_id: Option<usize>,
}

// This is used for merging iterators of EdgeRefs and only makes sense if the local node for both
// sides is the same
impl PartialOrd for EdgeRef {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.remote().partial_cmp(&other.remote())
    }
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum Dir {
    Into,
    Out,
}

impl EdgeRef {
    #[inline]
    pub fn new_outgoing(e_pid: EID, src_pid: VID, dst_pid: VID) -> Self {
        EdgeRef {
            e_pid,
            src_pid,
            dst_pid,
            e_type: Dir::Out,
            time: None,
            layer_id: None,
        }
    }

    #[inline]
    pub fn new_incoming(e_pid: EID, src_pid: VID, dst_pid: VID) -> Self {
        EdgeRef {
            e_pid,
            src_pid,
            dst_pid,
            e_type: Dir::Into,
            time: None,
            layer_id: None,
        }
    }

    #[inline]
    pub fn new(e_pid: EID, src_pid: VID, dst_pid: VID, dir: Dir) -> Self {
        Self {
            e_pid,
            src_pid,
            dst_pid,
            e_type: dir,
            time: None,
            layer_id: None,
        }
    }

    #[inline(always)]
    pub fn layer(&self) -> Option<usize> {
        self.layer_id
    }

    #[inline(always)]
    pub fn time(&self) -> Option<EventTime> {
        self.time
    }

    #[inline(always)]
    pub fn time_t(&self) -> Option<i64> {
        self.time.map(|t| t.t())
    }

    #[inline]
    pub fn dir(&self) -> Dir {
        self.e_type
    }

    #[inline]
    pub fn src(&self) -> VID {
        self.src_pid
    }

    #[inline]
    pub fn dst(&self) -> VID {
        self.dst_pid
    }

    #[inline]
    pub fn remote(&self) -> VID {
        match self.e_type {
            Dir::Into => self.src(),
            Dir::Out => self.dst(),
        }
    }

    #[inline]
    pub fn local(&self) -> VID {
        match self.e_type {
            Dir::Into => self.dst(),
            Dir::Out => self.src(),
        }
    }

    #[inline(always)]
    pub fn pid(&self) -> EID {
        self.e_pid
    }

    #[inline]
    pub fn at(&self, time: EventTime) -> Self {
        let mut e_ref = *self;
        e_ref.time = Some(time);
        e_ref
    }

    #[inline]
    pub fn at_layer(&self, layer: usize) -> Self {
        let mut e_ref = *self;
        e_ref.layer_id = Some(layer);
        e_ref
    }

    #[inline]
    pub fn unexplode(mut self) -> Self {
        self.layer_id = None;
        self.time = None;
        self
    }
}