raphtory 0.17.0

raphtory, a temporal graph 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
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

use crate::{
    algorithms::dynamics::temporal::epidemics::{
        Infected, IntoSeeds, Number, Probability, SeedError,
    },
    core::entities::VID,
    db::api::view::StaticGraphViewOps,
    python::{
        types::repr::{Repr, StructReprBuilder},
        utils::PyNodeRef,
    },
};
use pyo3::{
    prelude::*,
    types::{PyFloat, PyInt},
};
use rand::Rng;
use raphtory_api::python::error::adapt_err_value;

impl Repr for Infected {
    fn repr(&self) -> String {
        StructReprBuilder::new("Infected")
            .add_field("infected", self.infected)
            .add_field("active", self.active)
            .add_field("recovered", self.recovered)
            .finish()
    }
}

#[pyclass(name = "Infected", frozen, module = "raphtory.algorithms")]
pub struct PyInfected {
    inner: Infected,
}

#[pymethods]
impl PyInfected {
    /// The timestamp at which the node was infected
    ///
    /// Returns:
    ///     int:
    #[getter]
    fn infected(&self) -> i64 {
        self.inner.infected
    }

    /// The timestamp at which the infected node started spreading the infection
    ///
    /// Returns:
    ///     int:
    #[getter]
    fn active(&self) -> i64 {
        self.inner.active
    }

    /// The timestamp at which the infected node stopped spreading the infection
    ///
    /// Returns:
    ///     int:
    #[getter]
    fn recovered(&self) -> i64 {
        self.inner.recovered
    }

    fn __repr__(&self) -> String {
        self.inner.repr()
    }
}

impl<'py> IntoPyObject<'py> for Infected {
    type Target = PyInfected;
    type Output = Bound<'py, Self::Target>;
    type Error = <Self::Target as IntoPyObject<'py>>::Error;

    fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {
        PyInfected { inner: self }.into_pyobject(py)
    }
}

impl<'py> FromPyObject<'py> for Infected {
    fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self> {
        let res = ob.downcast::<PyInfected>()?;
        Ok(res.get().inner)
    }
}

pub enum PySeed {
    List(Vec<PyNodeRef>),
    Number(usize),
    Probability(f64),
}

impl<'source> FromPyObject<'source> for PySeed {
    fn extract_bound(ob: &Bound<'source, PyAny>) -> PyResult<Self> {
        let res = if ob.is_instance_of::<PyInt>() {
            Self::Number(ob.extract()?)
        } else if ob.is_instance_of::<PyFloat>() {
            Self::Probability(ob.extract()?)
        } else {
            Self::List(ob.extract()?)
        };
        Ok(res)
    }
}

impl IntoSeeds for PySeed {
    fn into_initial_list<G: StaticGraphViewOps, R: Rng + ?Sized>(
        self,
        graph: &G,
        rng: &mut R,
    ) -> Result<Vec<VID>, SeedError> {
        match self {
            PySeed::List(v) => v.into_initial_list(graph, rng),
            PySeed::Number(v) => Number(v).into_initial_list(graph, rng),
            PySeed::Probability(p) => Probability::try_from(p)?.into_initial_list(graph, rng),
        }
    }
}
impl From<SeedError> for PyErr {
    fn from(value: SeedError) -> Self {
        adapt_err_value(&value)
    }
}