Skip to main content

sc_neurocore_engine/bindings/population/
larter_breakspear.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Commercial license available
3// © Concepts 1996–2026 Miroslav Šotek. All rights reserved.
4// © Code 2020–2026 Miroslav Šotek. All rights reserved.
5// ORCID: 0009-0009-3560-0851
6// Contact: www.anulum.li | protoscience@anulum.li
7// SC-NeuroCore — Larter-Breakspear neural-mass PyO3 binding
8
9use pyo3::prelude::*;
10use pyo3::types::PyDict;
11
12use crate::neurons;
13
14#[pyclass(
15    name = "LarterBreakspearNeuron",
16    module = "sc_neurocore_engine.sc_neurocore_engine"
17)]
18#[derive(Clone)]
19pub struct PyLarterBreakspearNeuron {
20    inner: neurons::LarterBreakspearNeuron,
21}
22
23#[pymethods]
24impl PyLarterBreakspearNeuron {
25    #[new]
26    fn new() -> Self {
27        Self {
28            inner: neurons::LarterBreakspearNeuron::new(),
29        }
30    }
31
32    #[pyo3(signature = (coupling=0.0))]
33    fn step(&mut self, coupling: f64) -> f64 {
34        self.inner.step(coupling)
35    }
36
37    fn reset(&mut self) {
38        self.inner.reset();
39    }
40
41    fn get_state(&self, py: Python<'_>) -> PyResult<Py<PyAny>> {
42        let d = PyDict::new(py);
43        d.set_item("v", self.inner.v)?;
44        d.set_item("w", self.inner.w)?;
45        d.set_item("z", self.inner.z)?;
46        Ok(d.into_any().unbind())
47    }
48}
49
50pub(super) fn register(module: &Bound<'_, PyModule>) -> PyResult<()> {
51    module.add_class::<PyLarterBreakspearNeuron>()?;
52    Ok(())
53}