Struct Sparse Graph &nbsp; Copy item path

impl<T> SparseGraph<T>
where T: Clone + BixverseFloat + Sum,

pub fn new( num_nodes: usize, adjacency: CompressedSparseData2<T>, directed: bool, ) -> Self

Generate a new SparseGraph

§Params

num_nodes - Number of nodes in the graph
adjacency - CompressedSparseData2 containing the adjacency information
directed - Is this a directed or undirected graph

§Returns

Initialised self

pub fn get_neighbours(&self, node: usize) -> (Vec<usize>, &[T])

Helper function to get the neighbours and weights

§Params

node - Index of the node for which to get the neighbours

§Return

Tuple of (neighbour_indices, edge_weights)

pub fn get_neighbours_raw(&self, node: usize) -> (&[u32], &[T])

Get the neighbours and weights without allocating

§Params

node - Index of the node for which to get the neighbours

§Return

Tuple of (neighbour_indices, edge_weights), borrowed from the CSR

pub fn get_node_degree(&self, node: usize) -> usize

Get the node degree

§Params

node - Index of the node to get the node degree from

§Return

The node degree for this node.

pub fn total_weight(&self) -> T

Get total weight

§Params

undirected - Is the graph undirected or not.

§Returns

The total edge weight

pub fn get_node_number(&self) -> usize

Expose the number of nodes

§Returns

The number of nodes in the graph

pub fn is_directed(&self) -> bool

Expose if graph is directed

§Returns

Boolean indicating if graph is directed

pub fn get_edge_number(&self) -> usize

Number of edges

An undirected graph stores every edge twice, a self-loop included (both entries in its own row, as edge_pairs_to_sparse_graph builds it).

§Returns

The number of stored entries for a directed graph, half of them for an undirected one.

pub fn to_edge_pairs(&self) -> (Vec<u32>, Vec<T>)
where T: Send + Sync,

Flatten the graph into an edge-pair list

The inverse of edge_pairs_to_sparse_graph: an undirected edge comes out once, as (i, j) with i < j, and a self-loop once for each pair of entries it holds. A directed graph gives every stored entry. Rows are flattened in parallel, one chunk per worker, so the order is by source node, then by the CSR order within the row.

§Returns

Tuple of (edges, weights): edges holds the pairs flat, [u, v, u, v, ...], 0-based; weights one weight per pair.

impl<T> SparseGraph<T>
where T: Clone + BixverseFloat + Sum + Serialize + DeserializeOwned,

pub fn to_bytes(&self) -> Result<Vec<u8>, MethodsErrors>

Serialise the graph to bytes

§Returns

A blob that Self::from_bytes reads back. See bixverse_sparse::serialise for the layout.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, MethodsErrors>

Read a graph written by Self::to_bytes

The adjacency is checked for being a structurally sound square CSR over num_nodes nodes, since the bytes may come from disk.

§Params

bytes - The blob

§Returns

The graph, or a header, decode or validation error.

Trait Implementations§

impl<T: Clone + Clone> Clone for SparseGraph<T>

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug + Clone> Debug for SparseGraph<T>

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

Formats the value using the given formatter. Read more

impl<'de, T> Deserialize<'de> for SparseGraph<T>
where T: Deserialize<'de> + Clone,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<T> Serialize for SparseGraph<T>
where T: Serialize + Clone,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl<T> Freeze for SparseGraph<T>
where CompressedSparseData2<T>: Freeze,

impl<T> RefUnwindSafe for SparseGraph<T>
where CompressedSparseData2<T>: RefUnwindSafe,

impl<T> UnsafeUnpin for SparseGraph<T>
where CompressedSparseData2<T>: UnsafeUnpin,

impl<T> UnwindSafe for SparseGraph<T>
where CompressedSparseData2<T>: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByRef<T> for T

fn by_ref(&self) -> &T

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

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

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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