Trait graphannis::graph::GraphStorage

pub trait GraphStorage: EdgeContainer {
    fn find_connected(
        &'a self, 
        node: u64, 
        min_distance: usize, 
        max_distance: Bound<usize>
    ) -> Box<dyn Iterator<Item = u64> + 'a, Global>;
    fn find_connected_inverse(
        &'a self, 
        node: u64, 
        min_distance: usize, 
        max_distance: Bound<usize>
    ) -> Box<dyn Iterator<Item = u64> + 'a, Global>;
    fn distance(&self, source: u64, target: u64) -> Option<usize>;
    fn is_connected(
        &self, 
        source: u64, 
        target: u64, 
        min_distance: usize, 
        max_distance: Bound<usize>
    ) -> bool;
    fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>;
    fn copy(
        &mut self, 
        node_annos: &dyn AnnotationStorage<u64>, 
        orig: &dyn GraphStorage
    ) -> Result<(), GraphAnnisCoreError>;
    fn as_edgecontainer(&self) -> &dyn EdgeContainer;
    fn serialization_id(&self) -> String;
    fn load_from(location: &Path) -> Result<Self, GraphAnnisCoreError>;
    fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>;

    fn as_writeable(&mut self) -> Option<&mut dyn WriteableGraphStorage> { ... }
    fn inverse_has_same_cost(&self) -> bool { ... }
}

A graph storage is the representation of an edge component of a graph with specific structures. These specific structures are exploited to efficiently implement reachability queries.

Required methods

fn find_connected(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

Find all nodes reachable from a given start node inside the component.

fn find_connected_inverse(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

Find all nodes reachable from a given start node inside the component, when the directed edges are inversed.

fn distance(&self, source: u64, target: u64) -> Option<usize>

Compute the distance (shortest path length) of two nodes inside this component.

fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

Check if two nodes are connected with any path in this component given a minimum (min_distance) and maximum (max_distance) path length.

fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

Get the annotation storage for the edges of this graph storage.

fn copy(
    &mut self,
    node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

Copy the content of another component. This removes the existing content of this graph storage.

fn as_edgecontainer(&self) -> &dyn EdgeContainer

Upcast this graph storage to the EdgeContainer trait.

fn serialization_id(&self) -> String

Return an identifier for this graph storage which is used to distinguish the different graph storages when (de-) serialized.

fn load_from(location: &Path) -> Result<Self, GraphAnnisCoreError>

Load the graph storage from a location on the disk. This location is a directory, which can contain files specific to this graph storage.

fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

Save the graph storage a location on the disk. This location must point to an existing directory.

Provided methods

fn as_writeable(&mut self) -> Option<&mut dyn WriteableGraphStorage>

Try to downcast this graph storage to a WriteableGraphStorage trait. Returns None if this graph storage is not writable.

fn inverse_has_same_cost(&self) -> bool

If true, finding the inverse connected nodes via find_connected_inverse(…) has the same cost as the non-inverse case.

Implementations on Foreign Types

impl GraphStorage for AdjacencyListStorage

pub fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

pub fn serialization_id(&self) -> String

pub fn load_from(
    location: &Path
) -> Result<AdjacencyListStorage, GraphAnnisCoreError> where
    AdjacencyListStorage: Sized,
    AdjacencyListStorage: for<'de> Deserialize<'de>, 

pub fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

pub fn find_connected(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn find_connected_inverse(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn distance(&self, source: u64, target: u64) -> Option<usize>

pub fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

pub fn copy(
    &mut self,
    _node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

pub fn as_writeable(&mut self) -> Option<&mut dyn WriteableGraphStorage>

pub fn as_edgecontainer(&self) -> &dyn EdgeContainer

pub fn inverse_has_same_cost(&self) -> bool

impl<OrderT, LevelT> GraphStorage for PrePostOrderStorage<OrderT, LevelT> where
    OrderT: 'static + NumValue + for<'de> Deserialize<'de> + Serialize,
    LevelT: 'static + NumValue + for<'de> Deserialize<'de> + Serialize, 

pub fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

pub fn serialization_id(&self) -> String

pub fn load_from(
    location: &Path
) -> Result<PrePostOrderStorage<OrderT, LevelT>, GraphAnnisCoreError> where
    PrePostOrderStorage<OrderT, LevelT>: Sized,
    PrePostOrderStorage<OrderT, LevelT>: for<'de> Deserialize<'de>, 

pub fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

pub fn find_connected(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn find_connected_inverse(
    &'a self,
    start_node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn distance(&self, source: u64, target: u64) -> Option<usize>

pub fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

pub fn copy(
    &mut self,
    node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

pub fn as_edgecontainer(&self) -> &dyn EdgeContainer

impl GraphStorage for DiskAdjacencyListStorage

pub fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

pub fn serialization_id(&self) -> String

pub fn load_from(
    location: &Path
) -> Result<DiskAdjacencyListStorage, GraphAnnisCoreError> where
    DiskAdjacencyListStorage: Sized, 

pub fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

pub fn find_connected(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn find_connected_inverse(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn distance(&self, source: u64, target: u64) -> Option<usize>

pub fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

pub fn copy(
    &mut self,
    _node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

pub fn as_writeable(&mut self) -> Option<&mut dyn WriteableGraphStorage>

pub fn as_edgecontainer(&self) -> &dyn EdgeContainer

pub fn inverse_has_same_cost(&self) -> bool

impl<PosT> GraphStorage for LinearGraphStorage<PosT> where
    PosT: 'static + NumValue + for<'de> Deserialize<'de> + Serialize, 

pub fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

pub fn serialization_id(&self) -> String

pub fn load_from(
    location: &Path
) -> Result<LinearGraphStorage<PosT>, GraphAnnisCoreError> where
    LinearGraphStorage<PosT>: Sized,
    LinearGraphStorage<PosT>: for<'de> Deserialize<'de>, 

pub fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

pub fn find_connected(
    &'a self,
    source: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn find_connected_inverse(
    &'a self,
    source: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn distance(&self, source: u64, target: u64) -> Option<usize>

pub fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

pub fn copy(
    &mut self,
    node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

pub fn inverse_has_same_cost(&self) -> bool

pub fn as_edgecontainer(&self) -> &dyn EdgeContainer

impl GraphStorage for DenseAdjacencyListStorage

pub fn serialization_id(&self) -> String

Return an identifier for this graph storage which is used to distinguish the different graph storages when (de-) serialized.

pub fn find_connected(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn find_connected_inverse(
    &'a self,
    node: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> Box<dyn Iterator<Item = u64> + 'a, Global>

pub fn distance(&self, source: u64, target: u64) -> Option<usize>

pub fn is_connected(
    &self,
    source: u64,
    target: u64,
    min_distance: usize,
    max_distance: Bound<usize>
) -> bool

pub fn get_anno_storage(&self) -> &dyn AnnotationStorage<Edge>

pub fn copy(
    &mut self,
    node_annos: &dyn AnnotationStorage<u64>,
    orig: &dyn GraphStorage
) -> Result<(), GraphAnnisCoreError>

pub fn as_edgecontainer(&self) -> &dyn EdgeContainer

pub fn inverse_has_same_cost(&self) -> bool

pub fn load_from(
    location: &Path
) -> Result<DenseAdjacencyListStorage, GraphAnnisCoreError> where
    DenseAdjacencyListStorage: Sized,
    DenseAdjacencyListStorage: for<'de> Deserialize<'de>, 

pub fn save_to(&self, location: &Path) -> Result<(), GraphAnnisCoreError>

Implementors