Struct CsrGraph 

pub struct CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>
where
    NodeIndex: LayoutIndex,
    EdgeIndex: LayoutIndex,
    OffsetWord: LayoutWord<Index = EdgeIndex>,
    TargetWord: LayoutWord<Index = NodeIndex>,
{ /* private fields */ }

Borrowed compressed-sparse-row graph view.

The graph stores outgoing adjacency using offsets[node]..offsets[node + 1] ranges into the flat targets slice. The view borrows both slices and does not allocate. NodeIndex is the host-endian logical index type used for node IDs and target entries. EdgeIndex is the host-endian logical index type used for edge IDs and offset entries. The borrowed offset and target slices may use native words or matching little-endian zerocopy words.

Performance

Creating a validated view is O(n + m) for n nodes and m edges because validation checks monotonic offsets and target bounds. Outgoing traversal for one node is O(1) to create and O(k) to yield k outgoing edges.

Implementations

impl<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord> CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

pub fn validate( node_count: NodeIndex, offsets: &'view [OffsetWord], targets: &'view [TargetWord], ) -> Result<Self, CsrError<NodeIndex, EdgeIndex>>

Validates borrowed CSR sections and returns a graph view.

Errors

Returns CsrError when offsets have the wrong length, offsets are not monotonic, the final offset does not match targets.len(), a target is out of range, or an index count cannot be represented as usize on the current target.

Performance

Validation is O(n + m) for n nodes and m edges.

pub const fn offsets(&self) -> &'view [OffsetWord]

Returns the borrowed CSR offset slice.

Performance

This method is O(1).

pub const fn targets(&self) -> &'view [TargetWord]

Returns the borrowed CSR target slice.

Performance

This method is O(1).

pub fn for_each_out_target( &self, source: CsrNodeId<NodeIndex>, visit: impl FnMut(CsrNodeId<NodeIndex>) -> bool, ) -> bool

Walks outgoing target node ids for source via the CSR target slice.

Stops early when visit returns true. Returns true when stopped early.

Performance

This method is O(k) for k outgoing edges with no iterator adapters.

pub fn contains_node(&self, node: CsrNodeId<NodeIndex>) -> bool

Returns whether node is valid in this CSR view.

Performance

This method is O(1).

pub fn contains_edge(&self, edge: CsrEdgeId<EdgeIndex>) -> bool

Returns whether edge is valid in this CSR view.

Performance

This method is O(1).

pub fn try_target( &self, edge: CsrEdgeId<EdgeIndex>, ) -> Option<CsrNodeId<NodeIndex>>

Returns the target node for edge when edge is valid in this view.

Performance

This method is O(1).

impl<'view, NodeIndex, EdgeIndex> CsrGraph<'view, NodeIndex, EdgeIndex, <EdgeIndex as SnapshotWidth>::LittleEndianWord, <NodeIndex as SnapshotWidth>::LittleEndianWord>

where NodeIndex: CsrSnapshotIndex, EdgeIndex: CsrSnapshotIndex,

pub fn from_snapshot( snapshot: &Snapshot<'view>, ) -> Result<Self, CsrSnapshotError<NodeIndex, EdgeIndex>>

Builds a snapshot-backed CSR view from a validated Snapshot.

Reads the width-specific CSR offsets and targets sections, borrows them as little-endian index words, derives node_count from offsets.len() - 1, and runs CSR-shape validation. The returned view borrows directly from the snapshot’s byte slice and does not copy. Use CsrSnapshotGraph to select node and edge snapshot widths, for example CsrSnapshotGraph<'_, u32, u64>.

This delegates to from_snapshot_with_kinds using the width-default offsets/targets kinds and section version.

Errors

Returns CsrSnapshotError when either section is missing, has the wrong version, cannot be viewed as the selected word width, is empty, has too many offsets for the selected index type, or fails CSR validation.

Performance

This function is O(s + n + m) for s snapshot sections, n graph nodes, and m graph edges.

pub fn from_snapshot_with_kinds( snapshot: &Snapshot<'view>, offsets_kind: u32, targets_kind: u32, version: u32, ) -> Result<Self, CsrSnapshotError<NodeIndex, EdgeIndex>>

Builds a snapshot-backed CSR view using caller-chosen section kinds.

Identical to from_snapshot but with the offsets and targets section kinds and the section version supplied explicitly, so storage layers that persist CSR in a non-default band (for example an inbound CSC index) can reuse the same validated borrow logic.

Errors

Returns CsrSnapshotError when either section is missing, has the wrong version, cannot be viewed as the selected word width, is empty, has too many offsets for the selected index type, or fails CSR validation.

Performance

This function is O(s + n + m) for s snapshot sections, n graph nodes, and m graph edges.

Trait Implementations

impl<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord> Clone for CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex + Clone, EdgeIndex: LayoutIndex + Clone, OffsetWord: LayoutWord<Index = EdgeIndex> + Clone, TargetWord: LayoutWord<Index = NodeIndex> + Clone,

fn clone(&self) -> CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> ContainsElement for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn contains_element(&self, element: CsrNodeId<NodeIndex>) -> bool

Returns whether element is valid and visible in this view.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> ContainsRelation for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn contains_relation(&self, relation: CsrEdgeId<EdgeIndex>) -> bool

Returns whether relation is valid and visible in this view.

impl<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord> Copy for CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex + Copy, EdgeIndex: LayoutIndex + Copy, OffsetWord: LayoutWord<Index = EdgeIndex> + Copy, TargetWord: LayoutWord<Index = NodeIndex> + Copy,

impl<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord> Debug for CsrGraph<'view, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex + Debug, EdgeIndex: LayoutIndex + Debug, OffsetWord: LayoutWord<Index = EdgeIndex> + Debug, TargetWord: LayoutWord<Index = NodeIndex> + Debug,

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

Formats the value using the given formatter.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> EdgeTargetGraph for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn target(&self, edge: CsrEdgeId<EdgeIndex>) -> CsrNodeId<NodeIndex>

Returns the target node of edge. edge must be a valid edge ID.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> ElementIndex for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn element_bound(&self) -> usize

Returns the exclusive upper bound for element indexes in this view.

fn element_index(&self, element: CsrNodeId<NodeIndex>) -> usize

Returns the dense index for element in this view.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> ElementSuccessors for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

type Successors<'view> = IdSlice<'view, TargetWord, LocalId<NodeAxis, NodeIndex>> where Self: 'view

Iterator over successor element IDs reached from one element.

fn element_successors(&self, node: CsrNodeId<NodeIndex>) -> Self::Successors<'_>

Returns elements reachable through outgoing connections from element.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> GraphCounts for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn node_count(&self) -> usize

Returns the number of nodes visible in this graph view.

fn edge_count(&self) -> usize

Returns the number of edges visible in this graph view.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> OutgoingEdgeCount for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn out_degree(&self, node: CsrNodeId<NodeIndex>) -> usize

Returns the number of edges leaving node.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> OutgoingGraph for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

type OutEdges<'view> = CsrOutEdges<EdgeIndex> where Self: 'view

Iterator over edge IDs leaving one source node.

fn outgoing_edges(&self, node: CsrNodeId<NodeIndex>) -> Self::OutEdges<'_>

Returns edges whose source is node.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> RelationIndex for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn relation_bound(&self) -> usize

Returns the exclusive upper bound for relation indexes in this view.

fn relation_index(&self, relation: CsrEdgeId<EdgeIndex>) -> usize

Returns the dense index for relation in this view.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> TopologyBase for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

type ElementId = LocalId<NodeAxis, NodeIndex>

Identity of a topology element.

type RelationId = LocalId<EdgeAxis, EdgeIndex>

Identity of a topology relation.

impl<NodeIndex, EdgeIndex, OffsetWord, TargetWord> TopologyCounts for CsrGraph<'_, NodeIndex, EdgeIndex, OffsetWord, TargetWord>

where NodeIndex: LayoutIndex, EdgeIndex: LayoutIndex, OffsetWord: LayoutWord<Index = EdgeIndex>, TargetWord: LayoutWord<Index = NodeIndex>,

fn element_count(&self) -> usize

Returns the number of elements visible in this topology view.

fn relation_count(&self) -> usize

Returns the number of relations visible in this topology view.