Skip to main content

TraversalCache

Struct TraversalCache 

Source
pub struct TraversalCache { /* private fields */ }

Implementations§

Source§

impl TraversalCache

Source

pub fn from_topology(topology: &Topology) -> Self

Source

pub fn with_storage(topology: &Topology, requested: TraversalStorage) -> Self

Source

pub const fn node_count(&self) -> usize

Source

pub const fn edge_count(&self) -> usize

Source

pub const fn layout(&self) -> TraversalLayout

Source

pub fn storage_bytes(&self) -> usize

Source

pub fn fast_equivalent_bytes(&self) -> usize

Source

pub fn outgoing_neighbors(&self, node: NodeIndex) -> NeighborIter<'_>

Source

pub fn incoming_neighbors(&self, node: NodeIndex) -> NeighborIter<'_>

Source

pub fn out_degree(&self, node: NodeIndex) -> Option<usize>

Source

pub fn in_degree(&self, node: NodeIndex) -> Option<usize>

Source§

impl TraversalCache

Source

pub fn bfs_with_workspace<'workspace>( &self, start: NodeIndex, direction: Direction, workspace: &'workspace mut TraversalCacheWorkspace, ) -> &'workspace [NodeIndex]

Runs a materialized BFS without allocating after the workspace has grown.

Source§

impl TraversalCache

Source

pub fn storage_savings_bytes(&self) -> usize

Encoded bytes saved against a dual direct-u32 traversal CSR.

Source

pub fn storage_ratio(&self) -> f64

Encoded cache size divided by the equivalent direct cache size.

Source§

impl TraversalCache

Source

pub fn bfs_iter<'cache, 'workspace>( &'cache self, start: NodeIndex, direction: Direction, workspace: &'workspace mut TraversalCacheWorkspace, ) -> CacheBfs<'cache, 'workspace>

Source

pub fn dfs_iter<'cache, 'workspace>( &'cache self, start: NodeIndex, direction: Direction, workspace: &'workspace mut TraversalCacheWorkspace, ) -> CacheDfs<'cache, 'workspace>

Source

pub fn bfs(&self, start: NodeIndex, direction: Direction) -> Vec<NodeIndex>

Source

pub fn dfs(&self, start: NodeIndex, direction: Direction) -> Vec<NodeIndex>

Source

pub fn reachable( &self, source: NodeIndex, target: NodeIndex, direction: Direction, ) -> bool

Source

pub fn shortest_path( &self, source: NodeIndex, target: NodeIndex, direction: Direction, workspace: &mut TraversalCacheWorkspace, ) -> Option<Vec<NodeIndex>>

Trait Implementations§

Source§

impl Clone for TraversalCache

Source§

fn clone(&self) -> TraversalCache

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TraversalCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TraversalCache

Source§

impl From<&Graph> for TraversalCache

Source§

fn from(graph: &Graph) -> Self

Converts to this type from the input type.
Source§

impl From<&Topology> for TraversalCache

Source§

fn from(topology: &Topology) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TraversalCache

Source§

fn eq(&self, other: &TraversalCache) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TraversalCache

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.