Struct BcsrHypergraph 

pub struct BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>
where
    OffsetWord: LayoutWord<Index = IncidenceIndex>,
    VertexWord: LayoutWord<Index = VertexIndex>,
    RelationWord: LayoutWord<Index = RelationIndex>,
    VertexIndex: LayoutIndex,
    RelationIndex: LayoutIndex,
    IncidenceIndex: LayoutIndex,
{ /* private fields */ }

Borrowed bipartite compressed-sparse-row hypergraph view.

BcsrHypergraph borrows the eight section payloads supplied through BcsrSections without copying or allocating. 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, VertexIndex, RelationIndex, IncidenceIndex, <IncidenceIndex as SnapshotWidth>::LittleEndianWord, <VertexIndex as SnapshotWidth>::LittleEndianWord, <RelationIndex as SnapshotWidth>::LittleEndianWord>

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, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord> BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>

where OffsetWord: LayoutWord<Index = IncidenceIndex>, VertexWord: LayoutWord<Index = VertexIndex>, RelationWord: LayoutWord<Index = RelationIndex>, VertexIndex: LayoutIndex, RelationIndex: LayoutIndex, IncidenceIndex: LayoutIndex,

pub fn open( sections: BcsrSections<'view, OffsetWord, VertexWord, 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, OffsetWord, VertexWord, 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<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord> Clone for BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>

where OffsetWord: LayoutWord<Index = IncidenceIndex> + Clone, VertexWord: LayoutWord<Index = VertexIndex> + Clone, RelationWord: LayoutWord<Index = RelationIndex> + Clone, VertexIndex: LayoutIndex + Clone, RelationIndex: LayoutIndex + Clone, IncidenceIndex: LayoutIndex + Clone,

fn clone( &self, ) -> BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V, R, I, O, VW, RW> ContainsElement for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns whether element is valid and visible in this view.

impl<V, R, I, O, VW, RW> ContainsIncidence for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns whether incidence is valid and visible in this view.

impl<V, R, I, O, VW, RW> ContainsRelation for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns whether relation is valid and visible in this view.

impl<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord> Copy for BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>

where OffsetWord: LayoutWord<Index = IncidenceIndex> + Copy, VertexWord: LayoutWord<Index = VertexIndex> + Copy, RelationWord: LayoutWord<Index = RelationIndex> + Copy, VertexIndex: LayoutIndex + Copy, RelationIndex: LayoutIndex + Copy, IncidenceIndex: LayoutIndex + Copy,

impl<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord> Debug for BcsrHypergraph<'view, VertexIndex, RelationIndex, IncidenceIndex, OffsetWord, VertexWord, RelationWord>

where OffsetWord: LayoutWord<Index = IncidenceIndex> + Debug, VertexWord: LayoutWord<Index = VertexIndex> + Debug, RelationWord: LayoutWord<Index = RelationIndex> + Debug, VertexIndex: LayoutIndex + Debug, RelationIndex: LayoutIndex + Debug, IncidenceIndex: LayoutIndex + Debug,

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

Formats the value using the given formatter.

impl<V, R, I, O, VW, RW> DirectedHyperedgeIncidences for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type SourceIncidences<'view> = BcsrParticipantSlice<I> where Self: 'view

Iterator over source-side participant incidence IDs.

type TargetIncidences<'view> = BcsrParticipantSlice<I> where Self: 'view

Iterator over target-side participant incidence IDs.

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

Returns source-side participant incidence IDs for hyperedge.

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

Returns target-side participant incidence IDs for hyperedge.

impl<V, R, I, O, VW, RW> DirectedHyperedgeParticipants for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Iterator over source-side participants in one directed hyperedge.

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

Iterator over target-side participants in one directed hyperedge.

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

Returns source-side participants for hyperedge.

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

Returns target-side participants for hyperedge.

impl<V, R, I, O, VW, RW> DirectedVertexHyperedges for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Iterator over hyperedges where the vertex is source-side.

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

Iterator over hyperedges where the vertex is target-side.

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

Returns hyperedges where vertex participates on the source side.

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

Returns hyperedges where vertex participates on the target side.

impl<V, R, I, O, VW, RW> ElementIncidenceCount for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns the number of incidences attached to element.

impl<V, R, I, O, VW, RW> ElementIncidences for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type Incidences<'view> = BcsrElementIncidences<'view, O, VW, RW> where Self: 'view

Iterator over incidence IDs for one element.

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

Returns incidences attached to element.

impl<V, R, I, O, VW, RW> ElementIndex for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn element_bound(&self) -> usize

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

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

Returns the dense index for element in this view.

impl<V, R, I, O, VW, RW> ElementPredecessors for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type Predecessors<'view> = BcsrNeighborVertices<'view, RW, O, VW> where Self: 'view

Iterator over predecessor element IDs reaching one element.

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

Returns elements that reach element through outgoing connections.

impl<V, R, I, O, VW, RW> ElementSuccessors for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type Successors<'view> = BcsrNeighborVertices<'view, RW, O, VW> where Self: 'view

Iterator over successor element IDs reached from one element.

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

Returns elements reachable through outgoing connections from element.

impl<V, R, I, O, VW, RW> HyperedgeParticipants for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Iterator over vertices participating in one hyperedge.

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

Returns vertices participating in hyperedge.

impl<V, R, I, O, VW, RW> HypergraphCounts for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn vertex_count(&self) -> usize

Returns the number of vertices visible in this hypergraph view.

fn hyperedge_count(&self) -> usize

Returns the number of hyperedges visible in this hypergraph view.

impl<V, R, I, O, VW, RW> IncidenceBase for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type IncidenceId = LocalId<IncidenceAxis, I>

Identity of one element’s participation in one relation.

type Role = BcsrRole

Implementation-defined participation role.

impl<V, R, I, O, VW, RW> IncidenceCounts for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn incidence_count(&self) -> usize

Returns the number of incidences visible in this topology view.

impl<V, R, I, O, VW, RW> IncidenceElement for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn incidence_element(&self, incidence: BcsrParticipantId<I>) -> BcsrVertexId<V>

Returns the element participating through incidence.

impl<V, R, I, O, VW, RW> IncidenceIndex for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn incidence_bound(&self) -> usize

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

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

Returns the dense index for incidence in this view.

impl<V, R, I, O, VW, RW> IncidenceRelation for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn incidence_relation( &self, incidence: BcsrParticipantId<I>, ) -> BcsrHyperedgeId<R>

Returns the relation containing incidence.

impl<V, R, I, O, VW, RW> IncidenceRole for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns the role for incidence.

impl<V, R, I, O, VW, RW> IncidentHyperedges for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Iterator over hyperedges incident to one vertex.

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

Returns hyperedges incident to vertex.

impl<V, R, I, O, VW, RW> RelationIncidenceCount for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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

Returns the number of incidences attached to relation.

impl<V, R, I, O, VW, RW> RelationIncidences for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type Incidences<'view> = Chain<BcsrParticipantSlice<I>, BcsrParticipantSlice<I>> where Self: 'view

Iterator over incidence IDs for one relation.

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

Returns incidences attached to relation.

impl<V, R, I, O, VW, RW> RelationIndex for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

fn relation_bound(&self) -> usize

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

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

Returns the dense index for relation in this view.

impl<V, R, I, O, VW, RW> TopologyBase for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

type ElementId = LocalId<VertexAxis, V>

Identity of a topology element.

type RelationId = LocalId<HyperedgeAxis, R>

Identity of a topology relation.

impl<V, R, I, O, VW, RW> TopologyCounts for BcsrHypergraph<'_, V, R, I, O, VW, RW>

where V: LayoutIndex, R: LayoutIndex, I: LayoutIndex, O: LayoutWord<Index = I>, VW: LayoutWord<Index = V>, RW: LayoutWord<Index = R>,

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.