Struct BcsrHypergraph 

pub struct BcsrHypergraph<'view, W: BcsrWords> { /* private fields */ }

Borrowed bipartite compressed-sparse-row hypergraph view.

BcsrHypergraph borrows the eight section payloads supplied through BcsrSections without copying or allocating. The single BcsrWords parameter selects the word family — NativeWords for host-order build-path views, LeWords for little-endian snapshot-backed views. Construction validates the borrowed slices according to the chosen BcsrValidation level. Once constructed, every traversal is O(degree) in either direction.

Performance

Construction is O(P_head + P_tail + P_outgoing + P_incoming) at BcsrValidation::Layout. BcsrValidation::Strict adds an O((P_head + P_tail) · log d) cross-direction walk where d is the maximum vertex outgoing or incoming degree.

Implementations

impl<'view, VertexIndex, RelationIndex, IncidenceIndex> BcsrHypergraph<'view, LeWords<VertexIndex, RelationIndex, IncidenceIndex>>

where VertexIndex: BcsrSnapshotIndex, RelationIndex: BcsrSnapshotIndex, IncidenceIndex: BcsrSnapshotIndex,

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

Opens a BcsrHypergraph backed by sections from snapshot.

Errors

Returns BcsrSnapshotError when any required section is missing, has the wrong width for the requested typed view, or fails bipartite-CSR validation.

Performance

O(s + P_head + P_tail + P_outgoing + P_incoming) for s snapshot sections and the four payload counts.

pub fn from_snapshot_with( snapshot: &Snapshot<'view>, level: BcsrValidation, ) -> Result<Self, BcsrSnapshotError>

Opens a BcsrHypergraph from snapshot at the requested validation level.

Errors

Returns BcsrSnapshotError for missing or wrong-width sections, and any crate::BcsrError surfaced through validation.

Performance

As Self::from_snapshot at BcsrValidation::Layout; with BcsrValidation::Strict, adds O((P_head + P_tail) * log d) for the cross-direction walk.

impl<'view, W: BcsrWords> BcsrHypergraph<'view, W>

pub fn open( sections: BcsrSections<'view, W::OffsetWord, W::VertexWord, W::RelationWord>, ) -> Result<Self, BcsrError>

Validates sections at BcsrValidation::Layout and returns a view.

Errors

Returns BcsrError when any layout invariant fails. See BcsrValidation::Layout for the full list.

Performance

O(P_head + P_tail + P_outgoing + P_incoming).

pub fn open_with( sections: BcsrSections<'view, W::OffsetWord, W::VertexWord, W::RelationWord>, level: BcsrValidation, ) -> Result<Self, BcsrError>

Validates sections at the requested level and returns a view.

Errors

Returns BcsrError when any invariant visible at level fails.

Performance

O(P_head + P_tail + P_outgoing + P_incoming) at BcsrValidation::Layout; adds O((P_head + P_tail) · log d) at BcsrValidation::Strict.

pub const fn vertex_count(&self) -> usize

Returns the number of vertices in this view.

Performance

This method is O(1).

pub const fn hyperedge_count(&self) -> usize

Returns the number of hyperedges in this view.

Performance

This method is O(1).

pub const fn outgoing_incidence_count(&self) -> usize

Returns the number of outgoing incidences (P_head == P_outgoing).

Performance

This method is O(1).

pub const fn incoming_incidence_count(&self) -> usize

Returns the number of incoming incidences (P_tail == P_incoming).

Performance

This method is O(1).

Trait Implementations

impl<W: BcsrWords> Clone for BcsrHypergraph<'_, W>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W: BcsrWords> ContainsElement for BcsrHypergraph<'_, W>

fn contains_element(&self, element: BcsrVertexId<W::VertexIndex>) -> bool

Returns whether element is valid and visible in this view.

impl<W: BcsrWords> ContainsIncidence for BcsrHypergraph<'_, W>

fn contains_incidence( &self, incidence: BcsrParticipantId<W::IncidenceIndex>, ) -> bool

Returns whether incidence is valid and visible in this view.

impl<W: BcsrWords> ContainsRelation for BcsrHypergraph<'_, W>

fn contains_relation(&self, relation: BcsrHyperedgeId<W::RelationIndex>) -> bool

Returns whether relation is valid and visible in this view.

impl<W: BcsrWords> Copy for BcsrHypergraph<'_, W>

impl<W: BcsrWords> Debug for BcsrHypergraph<'_, W>

where W::OffsetWord: Debug, W::VertexWord: Debug, W::RelationWord: Debug,

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

Formats the value using the given formatter.

impl<W: BcsrWords> DenseElementIndex for BcsrHypergraph<'_, W>

fn element_bound(&self) -> usize

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

fn element_index(&self, element: BcsrVertexId<W::VertexIndex>) -> usize

Returns the dense index for element in this view.

impl<W: BcsrWords> DenseIncidenceIndex for BcsrHypergraph<'_, W>

fn incidence_bound(&self) -> usize

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

fn incidence_index( &self, incidence: BcsrParticipantId<W::IncidenceIndex>, ) -> usize

Returns the dense index for incidence in this view.

impl<W: BcsrWords> DenseRelationIndex for BcsrHypergraph<'_, W>

fn relation_bound(&self) -> usize

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

fn relation_index(&self, relation: BcsrHyperedgeId<W::RelationIndex>) -> usize

Returns the dense index for relation in this view.

impl<W: BcsrWords> DirectedHyperedgeIncidences for BcsrHypergraph<'_, W>

type SourceIncidences<'view> = BcsrParticipantSlice<<W as BcsrWords>::IncidenceIndex> where Self: 'view

Iterator over source-side participant incidence IDs.

type TargetIncidences<'view> = BcsrParticipantSlice<<W as BcsrWords>::IncidenceIndex> where Self: 'view

Iterator over target-side participant incidence IDs.

fn source_incidences( &self, hyperedge: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::SourceIncidences<'_>

Returns source-side participant incidence IDs for hyperedge.

fn target_incidences( &self, hyperedge: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::TargetIncidences<'_>

Returns target-side participant incidence IDs for hyperedge.

impl<W: BcsrWords> DirectedHyperedgeParticipants for BcsrHypergraph<'_, W>

type SourceParticipants<'view> = BcsrIdSlice<'view, <W as BcsrWords>::VertexWord, LocalId<VertexAxis, <<W as BcsrWords>::VertexWord as LayoutWord>::Index>> where Self: 'view

Iterator over source-side participants in one directed hyperedge.

type TargetParticipants<'view> = BcsrIdSlice<'view, <W as BcsrWords>::VertexWord, LocalId<VertexAxis, <<W as BcsrWords>::VertexWord as LayoutWord>::Index>> where Self: 'view

Iterator over target-side participants in one directed hyperedge.

fn source_participants( &self, hyperedge: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::SourceParticipants<'_>

Returns source-side participants for hyperedge.

fn target_participants( &self, hyperedge: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::TargetParticipants<'_>

Returns target-side participants for hyperedge.

impl<W: BcsrWords> DirectedVertexHyperedges for BcsrHypergraph<'_, W>

type OutgoingHyperedges<'view> = BcsrIdSlice<'view, <W as BcsrWords>::RelationWord, LocalId<HyperedgeAxis, <<W as BcsrWords>::RelationWord as LayoutWord>::Index>> where Self: 'view

Iterator over hyperedges where the vertex is source-side.

type IncomingHyperedges<'view> = BcsrIdSlice<'view, <W as BcsrWords>::RelationWord, LocalId<HyperedgeAxis, <<W as BcsrWords>::RelationWord as LayoutWord>::Index>> where Self: 'view

Iterator over hyperedges where the vertex is target-side.

fn outgoing_hyperedges( &self, vertex: BcsrVertexId<W::VertexIndex>, ) -> Self::OutgoingHyperedges<'_>

Returns hyperedges where vertex participates on the source side.

fn incoming_hyperedges( &self, vertex: BcsrVertexId<W::VertexIndex>, ) -> Self::IncomingHyperedges<'_>

Returns hyperedges where vertex participates on the target side.

impl<W: BcsrWords> ElementIncidenceCount for BcsrHypergraph<'_, W>

fn element_incidence_count( &self, element: BcsrVertexId<W::VertexIndex>, ) -> usize

Returns the number of incidences attached to element.

impl<W: BcsrWords> ElementIncidences for BcsrHypergraph<'_, W>

type Incidences<'view> = BcsrElementIncidences<'view, <W as BcsrWords>::OffsetWord, <W as BcsrWords>::VertexWord, <W as BcsrWords>::RelationWord> where Self: 'view

Iterator over incidence IDs for one element.

fn element_incidences( &self, element: BcsrVertexId<W::VertexIndex>, ) -> Self::Incidences<'_>

Returns incidences attached to element.

impl<W: BcsrWords> ElementPredecessors for BcsrHypergraph<'_, W>

type Predecessors<'view> = BcsrNeighborVertices<'view, <W as BcsrWords>::RelationWord, <W as BcsrWords>::OffsetWord, <W as BcsrWords>::VertexWord> where Self: 'view

Iterator over predecessor element IDs reaching one element.

fn element_predecessors( &self, vertex: BcsrVertexId<W::VertexIndex>, ) -> Self::Predecessors<'_>

Returns elements that reach element through outgoing connections.

impl<W: BcsrWords> ElementSuccessors for BcsrHypergraph<'_, W>

type Successors<'view> = BcsrNeighborVertices<'view, <W as BcsrWords>::RelationWord, <W as BcsrWords>::OffsetWord, <W as BcsrWords>::VertexWord> where Self: 'view

Iterator over successor element IDs reached from one element.

fn element_successors( &self, vertex: BcsrVertexId<W::VertexIndex>, ) -> Self::Successors<'_>

Returns elements reachable through outgoing connections from element.

impl<W: BcsrWords> HyperedgeParticipants for BcsrHypergraph<'_, W>

type Participants<'view> = Chain<BcsrIdSlice<'view, <W as BcsrWords>::VertexWord, LocalId<VertexAxis, <<W as BcsrWords>::VertexWord as LayoutWord>::Index>>, BcsrIdSlice<'view, <W as BcsrWords>::VertexWord, LocalId<VertexAxis, <<W as BcsrWords>::VertexWord as LayoutWord>::Index>>> where Self: 'view

Iterator over vertices participating in one hyperedge.

fn hyperedge_participants( &self, hyperedge: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::Participants<'_>

Returns vertices participating in hyperedge.

impl<W: BcsrWords> IncidenceBase for BcsrHypergraph<'_, W>

type IncidenceId = LocalId<IncidenceAxis, <W as BcsrWords>::IncidenceIndex>

Identity of one element’s participation in one relation.

type Role = BcsrRole

Implementation-defined participation role.

impl<W: BcsrWords> IncidenceCounts for BcsrHypergraph<'_, W>

fn incidence_count(&self) -> usize

Returns the number of incidences visible in this topology view.

impl<W: BcsrWords> IncidenceElement for BcsrHypergraph<'_, W>

fn incidence_element( &self, incidence: BcsrParticipantId<W::IncidenceIndex>, ) -> BcsrVertexId<W::VertexIndex>

Returns the element participating through incidence.

impl<W: BcsrWords> IncidenceRelation for BcsrHypergraph<'_, W>

fn incidence_relation( &self, incidence: BcsrParticipantId<W::IncidenceIndex>, ) -> BcsrHyperedgeId<W::RelationIndex>

Returns the relation containing incidence.

impl<W: BcsrWords> IncidenceRole for BcsrHypergraph<'_, W>

fn incidence_role( &self, incidence: BcsrParticipantId<W::IncidenceIndex>, ) -> BcsrRole

Returns the role for incidence.

impl<W: BcsrWords> IncidentHyperedges for BcsrHypergraph<'_, W>

type IncidentHyperedges<'view> = Chain<BcsrIdSlice<'view, <W as BcsrWords>::RelationWord, LocalId<HyperedgeAxis, <<W as BcsrWords>::RelationWord as LayoutWord>::Index>>, BcsrIdSlice<'view, <W as BcsrWords>::RelationWord, LocalId<HyperedgeAxis, <<W as BcsrWords>::RelationWord as LayoutWord>::Index>>> where Self: 'view

Iterator over hyperedges incident to one vertex.

fn incident_hyperedges( &self, vertex: BcsrVertexId<W::VertexIndex>, ) -> Self::IncidentHyperedges<'_>

Returns hyperedges incident to vertex.

impl<W: BcsrWords> RelationIncidenceCount for BcsrHypergraph<'_, W>

fn relation_incidence_count( &self, relation: BcsrHyperedgeId<W::RelationIndex>, ) -> usize

Returns the number of incidences attached to relation.

impl<W: BcsrWords> RelationIncidences for BcsrHypergraph<'_, W>

type Incidences<'view> = Chain<BcsrParticipantSlice<<W as BcsrWords>::IncidenceIndex>, BcsrParticipantSlice<<W as BcsrWords>::IncidenceIndex>> where Self: 'view

Iterator over incidence IDs for one relation.

fn relation_incidences( &self, relation: BcsrHyperedgeId<W::RelationIndex>, ) -> Self::Incidences<'_>

Returns incidences attached to relation.

impl<W: BcsrWords> TopologyBase for BcsrHypergraph<'_, W>

type ElementId = LocalId<VertexAxis, <W as BcsrWords>::VertexIndex>

Identity of a topology element.

type RelationId = LocalId<HyperedgeAxis, <W as BcsrWords>::RelationIndex>

Identity of a topology relation.

impl<W: BcsrWords> TopologyCounts for BcsrHypergraph<'_, W>

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.