Skip to main content

GraphNeuralNetwork

Struct GraphNeuralNetwork 

Source
pub struct GraphNeuralNetwork {
    pub config: GnnConfig,
    pub nodes: Vec<NodeFeatures>,
    pub adjacency: Vec<Vec<(GnnNodeId, f64)>>,
    pub trained_iterations: u64,
}
Expand description

Message-passing Graph Neural Network.

Supports dynamic node/edge addition/removal, configurable aggregation strategies, and multi-layer propagation.

Fields§

§config: GnnConfig

GNN configuration (layers, aggregation, iterations).

§nodes: Vec<NodeFeatures>

Node feature vectors; index matches the logical node id.

§adjacency: Vec<Vec<(GnnNodeId, f64)>>

Adjacency list: adjacency[node_idx] = list of (neighbour_id, weight).

§trained_iterations: u64

Cumulative message-passing iterations executed so far.

Implementations§

Source§

impl GraphNeuralNetwork

Source

pub fn new(config: GnnConfig) -> Self

Create a new, empty graph neural network with the given configuration.

Source

pub fn add_node(&mut self, features: Vec<f64>) -> GnnNodeId

Append a new node with the provided feature vector.

Returns the GnnNodeId assigned to the new node.

Source

pub fn add_edge( &mut self, from: GnnNodeId, to: GnnNodeId, weight: f64, ) -> Result<(), GnnError>

Add an undirected edge between from and to with the given weight.

Both directions are stored so that neighbour aggregation works transparently for undirected graphs.

§Errors

Returns GnnError::NodeNotFound if either node id is out of bounds.

Source

pub fn remove_node(&mut self, id: GnnNodeId) -> bool

Remove the node with the given id together with all edges incident to it.

Returns true if the node existed, false otherwise.

Note: Removing a node renumbers all nodes with higher indices; any previously obtained GnnNodeIds for those nodes become stale.

Source

pub fn forward(&self) -> Vec<Vec<f64>>

Run num_iterations rounds of message passing and return the final node embeddings.

Each iteration:

  1. Every node aggregates its neighbours’ current feature vectors using the configured GnnAggregation.
  2. The aggregated vector is passed through every GnnLayer in order.

Returns one embedding Vec<f64> per node in node-index order.

Source

pub fn aggregate_neighbors( &self, node_id: GnnNodeId, features: &[Vec<f64>], ) -> Vec<f64>

Aggregate the feature vectors of node_id’s neighbours according to the configured aggregation strategy.

Falls back to the node’s own features when it has no neighbours.

Source

pub fn apply_layer(input: &[f64], layer: &GnnLayer) -> Vec<f64>

Apply a single layer (linear transform + bias + activation) to input.

layer.weights must be [output_dim × input_dim]. Rows shorter than input are zero-padded; inputs longer than any row are silently ignored for that row (safe defaults for heterogeneous graphs).

Source

pub fn node_embedding(&self, id: GnnNodeId) -> Result<Vec<f64>, GnnError>

Compute the embedding for a single node.

§Errors
Source

pub fn graph_embedding(&self) -> Vec<f64>

Compute the graph-level embedding as the element-wise mean of all node embeddings.

Returns an empty vector if the graph has no nodes or if the node embeddings are empty.

Source

pub fn num_nodes(&self) -> usize

Number of nodes in the graph.

Source

pub fn num_edges(&self) -> usize

Number of directed edges (2 per undirected edge).

Source

pub fn stats(&self) -> GnnStats

Return a statistics snapshot for the current graph state.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more