Trait GraphStorage

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

    // Provided methods
    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>( &'a self, node: u64, min_distance: usize, max_distance: Bound<usize>, ) -> Box<dyn Iterator<Item = Result<u64, GraphAnnisCoreError>> + 'a>

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

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

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, ) -> Result<Option<usize>, GraphAnnisCoreError>

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>, ) -> Result<bool, GraphAnnisCoreError>

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 EdgeAnnotationStorage

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

fn copy( &mut self, node_annos: &dyn NodeAnnotationStorage, 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>

where Self: Sized,

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.

Implementors

impl GraphStorage for AdjacencyListStorage

impl GraphStorage for DenseAdjacencyListStorage

impl GraphStorage for DiskAdjacencyListStorage

impl GraphStorage for DiskPathStorage

impl<OrderT, LevelT> GraphStorage for PrePostOrderStorage<OrderT, LevelT>

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

impl<PosT> GraphStorage for LinearGraphStorage<PosT>

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