Struct swh_graph::graph::SwhBidirectionalGraph

pub struct SwhBidirectionalGraph<P, FG: UnderlyingGraph = BVGraph<DynCodesDecoderFactory<BE, MmapHelper<u32>, EliasFano<SelectFixed2<CountBitVec<&'static [usize]>, &'static [u64], 8>, BitFieldVec<usize, &'static [usize]>>>>, BG: UnderlyingGraph = BVGraph<DynCodesDecoderFactory<BE, MmapHelper<u32>, EliasFano<SelectFixed2<CountBitVec<&'static [usize]>, &'static [u64], 8>, BitFieldVec<usize, &'static [usize]>>>>> { /* private fields */ }

Class representing the compressed Software Heritage graph in both directions.

Created using load_bidirectional.

Type parameters:

• P is either () or properties::SwhGraphProperties, manipulated using load_properties and load_all_properties
• FG is the forward graph (either [BVGraph], or Zip<BVGraph, SwhGraphLabels> after using load_forward_labels
• BG is the backward graph (either [BVGraph], or Zip<BVGraph, SwhGraphLabels> after using load_backward_labels

Implementations

impl<FG: UnderlyingGraph, BG: UnderlyingGraph> SwhBidirectionalGraph<(), FG, BG>

pub fn from_underlying_graphs( basepath: PathBuf, forward_graph: FG, backward_graph: BG ) -> Self

impl<M: MaybeMaps, T: MaybeTimestamps, P: MaybePersons, C: MaybeContents, S: MaybeStrings, N: MaybeLabelNames, BG: UnderlyingGraph, FG: UnderlyingGraph> SwhBidirectionalGraph<SwhGraphProperties<M, T, P, C, S, N>, FG, BG>

pub fn load_properties<M2: MaybeMaps, T2: MaybeTimestamps, P2: MaybePersons, C2: MaybeContents, S2: MaybeStrings, N2: MaybeLabelNames>( self, loader: impl Fn(SwhGraphProperties<M, T, P, C, S, N>) -> Result<SwhGraphProperties<M2, T2, P2, C2, S2, N2>> ) -> Result<SwhBidirectionalGraph<SwhGraphProperties<M2, T2, P2, C2, S2, N2>, FG, BG>>

Enriches the graph with more properties mmapped from disk

Example

use swh_graph::java_compat::mph::gov::GOVMPH;
use swh_graph::SwhGraphProperties;

swh_graph::graph::load_bidirectional(PathBuf::from("./graph"))
    .expect("Could not load graph")
    .init_properties()
    .load_properties(SwhGraphProperties::load_maps::<GOVMPH>)
    .expect("Could not load SWHID maps")
    .load_properties(SwhGraphProperties::load_timestamps)
    .expect("Could not load timestamps");

impl<FG: UnderlyingGraph, BG: UnderlyingGraph> SwhBidirectionalGraph<(), FG, BG>

pub fn init_properties( self ) -> SwhBidirectionalGraph<SwhGraphProperties<NoMaps, NoTimestamps, NoPersons, NoContents, NoStrings, NoLabelNames>, FG, BG>

Prerequisite for load_properties

pub fn load_all_properties<MPHF: SwhidMphf>( self ) -> Result<SwhBidirectionalGraph<SwhGraphProperties<MappedMaps<MPHF>, MappedTimestamps, MappedPersons, MappedContents, MappedStrings, MappedLabelNames>, FG, BG>>

Enriches the graph with more properties mmapped from disk

Example

use swh_graph::java_compat::mph::gov::GOVMPH;

swh_graph::graph::load_bidirectional(PathBuf::from("./graph"))
    .expect("Could not load graph")
    .load_all_properties::<GOVMPH>()
    .expect("Could not load properties");

impl<P, FG: RandomAccessGraph + UnderlyingGraph, BG: UnderlyingGraph> SwhBidirectionalGraph<P, FG, BG>

pub fn load_forward_labels( self ) -> Result<SwhBidirectionalGraph<P, Zip<FG, SwhLabels<MmapReaderBuilder, DeserType<'static, EF>>>, BG>>

Consumes this graph and returns a new one that implements SwhLabelledForwardGraph

impl<P, FG: UnderlyingGraph, BG: RandomAccessGraph + UnderlyingGraph> SwhBidirectionalGraph<P, FG, BG>

pub fn load_backward_labels( self ) -> Result<SwhBidirectionalGraph<P, FG, Zip<BG, SwhLabels<MmapReaderBuilder, DeserType<'static, EF>>>>>

Consumes this graph and returns a new one that implements SwhLabelledBackwardGraph

impl<P, FG: RandomAccessGraph + UnderlyingGraph, BG: RandomAccessGraph + UnderlyingGraph> SwhBidirectionalGraph<P, FG, BG>

pub fn load_labels( self ) -> Result<SwhBidirectionalGraph<P, Zip<FG, SwhLabels<MmapReaderBuilder, DeserType<'static, EF>>>, Zip<BG, SwhLabels<MmapReaderBuilder, DeserType<'static, EF>>>>>

Equivalent to calling both load_forward_labels and load_backward_labels

Trait Implementations

impl<P, FG: UnderlyingGraph, BG: UnderlyingGraph> SwhBackwardGraph for SwhBidirectionalGraph<P, FG, BG>

type Predecessors<'succ> = <BG as UnderlyingGraph>::UnlabeledSuccessors<'succ> where Self: 'succ

fn predecessors(&self, node_id: NodeId) -> Self::Predecessors<'_>

Return an IntoIterator over the predecessors of a node.

fn indegree(&self, node_id: NodeId) -> usize

Return the number of predecessors of a node.

impl<P, FG: UnderlyingGraph, BG: UnderlyingGraph> SwhForwardGraph for SwhBidirectionalGraph<P, FG, BG>

type Successors<'succ> = <FG as UnderlyingGraph>::UnlabeledSuccessors<'succ> where Self: 'succ

fn successors(&self, node_id: NodeId) -> Self::Successors<'_>

Return an IntoIterator over the successors of a node.

fn outdegree(&self, node_id: NodeId) -> usize

Return the number of successors of a node.

impl<P, FG: UnderlyingGraph, BG: UnderlyingGraph> SwhGraph for SwhBidirectionalGraph<P, FG, BG>

fn path(&self) -> &Path

Return the base path of the graph

fn is_transposed(&self) -> bool

Returns whether the graph is in the ori->snp->rel,rev->dir->cnt direction (with a few dir->rev arcs)

fn num_nodes(&self) -> usize

Return the number of nodes in the graph.

fn num_arcs(&self) -> u64

Return the number of arcs in the graph.

fn has_arc(&self, src_node_id: NodeId, dst_node_id: NodeId) -> bool

Return whether there is an arc going from src_node_id to dst_node_id.

fn has_node(&self, node_id: NodeId) -> bool

Returns whether the given node id exists in the graph

impl<MAPS: MaybeMaps, TIMESTAMPS: MaybeTimestamps, PERSONS: MaybePersons, CONTENTS: MaybeContents, STRINGS: MaybeStrings, LABELNAMES: MaybeLabelNames, BG: UnderlyingGraph, FG: UnderlyingGraph> SwhGraphWithProperties for SwhBidirectionalGraph<SwhGraphProperties<MAPS, TIMESTAMPS, PERSONS, CONTENTS, STRINGS, LABELNAMES>, FG, BG>

type Maps = MAPS

type Timestamps = TIMESTAMPS

type Persons = PERSONS

type Contents = CONTENTS

type Strings = STRINGS

type LabelNames = LABELNAMES

fn properties( &self ) -> &SwhGraphProperties<MAPS, TIMESTAMPS, PERSONS, CONTENTS, STRINGS, LABELNAMES>

impl<P, FG: UnderlyingGraph, BG: UnderlyingGraph> SwhLabelledBackwardGraph for SwhBidirectionalGraph<P, FG, BG>where <BG as SequentialLabeling>::Label: Pair<Left = NodeId>, <<BG as SequentialLabeling>::Label as Pair>::Right: IntoIterator, <<<BG as SequentialLabeling>::Label as Pair>::Right as IntoIterator>::Item: Borrow<u64>, for<'succ> <BG as RandomAccessLabeling>::Labels<'succ>: Iterator<Item = (usize, <<BG as SequentialLabeling>::Label as Pair>::Right)>,

type LabelledArcs<'arc> = LabelledArcIterator<<<<<BG as RandomAccessLabeling>::Labels<'arc> as Iterator>::Item as Pair>::Right as IntoIterator>::IntoIter> where Self: 'arc

type LabelledPredecessors<'succ> = LabelledSuccessorIterator<<BG as RandomAccessLabeling>::Labels<'succ>> where Self: 'succ

fn labelled_predecessors( &self, node_id: NodeId ) -> Self::LabelledPredecessors<'_>

Return an IntoIterator over the successors of a node.

impl<P, FG: UnderlyingGraph, BG: UnderlyingGraph> SwhLabelledForwardGraph for SwhBidirectionalGraph<P, FG, BG>where <FG as SequentialLabeling>::Label: Pair<Left = NodeId>, <<FG as SequentialLabeling>::Label as Pair>::Right: IntoIterator, <<<FG as SequentialLabeling>::Label as Pair>::Right as IntoIterator>::Item: Borrow<u64>, for<'succ> <FG as RandomAccessLabeling>::Labels<'succ>: Iterator<Item = (usize, <<FG as SequentialLabeling>::Label as Pair>::Right)>,

type LabelledArcs<'arc> = LabelledArcIterator<<<<<FG as RandomAccessLabeling>::Labels<'arc> as Iterator>::Item as Pair>::Right as IntoIterator>::IntoIter> where Self: 'arc

type LabelledSuccessors<'succ> = LabelledSuccessorIterator<<FG as RandomAccessLabeling>::Labels<'succ>> where Self: 'succ

fn labelled_successors(&self, node_id: NodeId) -> Self::LabelledSuccessors<'_>

Return an IntoIterator over the successors of a node.