Skip to main content

GraphData

Struct GraphData 

Source
pub struct GraphData {
    pub x: Tensor,
    pub edge_index: Tensor,
    pub edge_attr: Option<Tensor>,
    pub batch: Option<Tensor>,
    pub num_nodes: usize,
    pub num_edges: usize,
}
Expand description

Graph data structure for GNNs

Fields§

§x: Tensor

Node feature matrix (num_nodes x num_features)

§edge_index: Tensor

Edge index matrix (2 x num_edges)

§edge_attr: Option<Tensor>

Edge features (optional)

§batch: Option<Tensor>

Batch assignment vector (optional, for batched graphs)

§num_nodes: usize

Number of nodes

§num_edges: usize

Number of edges

Implementations§

Source§

impl GraphData

Source

pub fn new(x: Tensor, edge_index: Tensor) -> Self

Create a new graph data structure

§Arguments
  • x - Node feature matrix with shape [num_nodes, num_features]
  • edge_index - Edge connectivity with shape [2, num_edges]
§Returns

A new GraphData instance

§Example
use torsh_graph::GraphData;
use torsh_tensor::creation::from_vec;
use torsh_core::device::DeviceType;

// Create a simple triangle graph
let x = from_vec(vec![1.0, 2.0, 3.0], &[3, 1], DeviceType::Cpu).unwrap();
let edge_index = from_vec(
    vec![0.0, 1.0, 2.0, 1.0, 2.0, 0.0], // src, dst
    &[2, 3],
    DeviceType::Cpu
).unwrap();

let graph = GraphData::new(x, edge_index);
assert_eq!(graph.num_nodes, 3);
assert_eq!(graph.num_edges, 3);
Source

pub fn with_edge_attr(self, edge_attr: Tensor) -> Self

Add edge attributes

Source

pub fn with_batch(self, batch: Tensor) -> Self

Add batch assignment

Source

pub fn with_edge_attr_opt(self, edge_attr: Option<Tensor>) -> Self

Add edge attributes (optional chaining)

Source

pub fn memory_stats(&self) -> GraphMemoryStats

Get memory usage statistics

Source

pub fn validate(&self) -> Result<(), GraphValidationError>

Validate graph structure

Checks that:

  • All edge indices refer to valid nodes
  • Edge attributes (if present) match the number of edges
§Returns
  • Ok(()) - Graph structure is valid
  • Err(GraphValidationError) - Validation failed
§Example
use torsh_graph::GraphData;
use torsh_tensor::creation::from_vec;
use torsh_core::device::DeviceType;

let x = from_vec(vec![1.0, 2.0], &[2, 1], DeviceType::Cpu).unwrap();
let edge_index = from_vec(vec![0.0, 1.0], &[2, 1], DeviceType::Cpu).unwrap();
let graph = GraphData::new(x, edge_index);

assert!(graph.validate().is_ok());

Trait Implementations§

Source§

impl Clone for GraphData

Source§

fn clone(&self) -> GraphData

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GraphData

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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