traitgraph::implementation::petgraph_impl

Struct PetGraph

Source
pub struct PetGraph<NodeData, EdgeData>(/* private fields */);
Expand description

A wrapper around the petgraph::graph::Graph type replacing its methods with implementations of our traits.

Implementations§

Source§

impl<NodeData, EdgeData> PetGraph<NodeData, EdgeData>

Source

pub fn new() -> PetGraph<NodeData, EdgeData>

Create a new graph implemented using the petgraph::graph::Graph type.

Trait Implementations§

Source§

impl<NodeData: Clone, EdgeData: Clone> Clone for PetGraph<NodeData, EdgeData>

Source§

fn clone(&self) -> PetGraph<NodeData, EdgeData>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<NodeData: Debug, EdgeData: Debug> Debug for PetGraph<NodeData, EdgeData>

Source§

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

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

impl<NodeData, EdgeData> Default for PetGraph<NodeData, EdgeData>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<NodeData, EdgeData> GraphBase for PetGraph<NodeData, EdgeData>

Source§

type NodeData = NodeData

The data type associated with each node.
Source§

type EdgeData = EdgeData

The data type associated with each edge.
Source§

type OptionalNodeIndex = OptionalNodeIndex<usize>

The optional index type used for nodes.
Source§

type OptionalEdgeIndex = OptionalEdgeIndex<usize>

The optional index type used for edges.
Source§

type NodeIndex = NodeIndex<usize>

The index type used for nodes.
Source§

type EdgeIndex = EdgeIndex<usize>

The index type used for edges.
Source§

fn new_none_optional_node_index(&self) -> Self::OptionalNodeIndex

Returns the none value of the optional node index type used by the trait.
Source§

fn new_none_optional_edge_index(&self) -> Self::OptionalEdgeIndex

Returns the none value of the optional edge index type used by the trait.
Source§

impl<NodeData, EdgeData> ImmutableGraphContainer for PetGraph<NodeData, EdgeData>

Source§

type NodeIndices<'a> = GraphIndices<<PetGraph<NodeData, EdgeData> as GraphBase>::NodeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::OptionalNodeIndex> where Self: 'a

An iterator type over the node indices in this graph.
Source§

type EdgeIndices<'a> = GraphIndices<<PetGraph<NodeData, EdgeData> as GraphBase>::EdgeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::OptionalEdgeIndex> where Self: 'a

An iterator type over the edge indices in this graph.
Source§

type NodeIndicesCopied = GraphIndices<<PetGraph<NodeData, EdgeData> as GraphBase>::NodeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::OptionalNodeIndex>

An iterator type over the node indices in this graph. The iterator is independent of the lifetime of self, and hence allows concurrent modifications during iteration. Note that any modification to the graph is not reflected in the iterator after construction.
Source§

type EdgeIndicesCopied = GraphIndices<<PetGraph<NodeData, EdgeData> as GraphBase>::EdgeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::OptionalEdgeIndex>

An iterator type over the edge indices in this graph. The iterator is independent of the lifetime of self, and hence allows concurrent modifications during iteration. Note that any modification to the graph is not reflected in the iterator after construction.
Source§

fn node_indices(&self) -> Self::NodeIndices<'_>

Returns an iterator over the node indices in this graph.
Source§

fn edge_indices(&self) -> Self::EdgeIndices<'_>

Returns an iterator over the edge indices in this graph.
Source§

fn node_indices_copied(&self) -> Self::NodeIndicesCopied

Returns an iterator over the node indices in this graph. The iterator is independent of the lifetime of self, and hence allows concurrent modifications during iteration. Note that any modification to the graph is not reflected in the iterator after construction.
Source§

fn edge_indices_copied(&self) -> Self::EdgeIndicesCopied

Returns an iterator over the edge indices in this graph. The iterator is independent of the lifetime of self, and hence allows concurrent modifications during iteration. Note that any modification to the graph is not reflected in the iterator after construction.
Source§

fn contains_node_index(&self, node_id: Self::NodeIndex) -> bool

Returns true if this graph contains the given node index.
Source§

fn contains_edge_index(&self, edge_id: Self::EdgeIndex) -> bool

Returns true if this graph contains the given edge index.
Source§

fn node_count(&self) -> usize

Returns the amount of nodes in this graph.
Source§

fn edge_count(&self) -> usize

Returns the amount of edges in this graph.
Source§

fn node_data(&self, node_id: Self::NodeIndex) -> &Self::NodeData

Returns a reference to the node data associated with the given node id, or None if there is no such node.
Source§

fn edge_data(&self, edge_id: Self::EdgeIndex) -> &Self::EdgeData

Returns a reference to the edge data associated with the given edge id, or None if there is no such edge.
Source§

fn edge_endpoints(&self, edge_id: Self::EdgeIndex) -> Edge<Self::NodeIndex>

Returns the endpoints of an edge.
Source§

fn is_empty(&self) -> bool

Returns true if the graph is empty, i.e. contains no nodes or edges.
Source§

fn do_all_edges_endpoints_exist(&self) -> bool

Returns true if the nodes returned by edge_endpoints are part of the graph for all edges.
Source§

impl<NodeData, EdgeData> MutableGraphContainer for PetGraph<NodeData, EdgeData>

Source§

fn node_data_mut(&mut self, node_id: Self::NodeIndex) -> &mut Self::NodeData

Returns a mutable reference to the node data associated with the given node id, or None if there is no such node.
Source§

fn edge_data_mut(&mut self, edge_id: Self::EdgeIndex) -> &mut Self::EdgeData

Returns a mutable reference to the edge data associated with the given edge id, or None if there is no such edge.
Source§

fn add_node(&mut self, node_data: NodeData) -> Self::NodeIndex

Adds a new node with the given NodeData to the graph.
Source§

fn add_edge( &mut self, from: Self::NodeIndex, to: Self::NodeIndex, edge_data: EdgeData, ) -> Self::EdgeIndex

Adds a new edge with the given EdgeData to the graph.
Source§

fn remove_node(&mut self, node_id: Self::NodeIndex) -> Option<NodeData>

Removes the node with the given id from the graph. Note that this may change the ids of existing nodes.
Source§

fn remove_edge(&mut self, edge_id: Self::EdgeIndex) -> Option<EdgeData>

Removes the edge with the given id from the graph. Note that this may change the ids of existing edges.
Source§

fn remove_edges_sorted(&mut self, edge_ids: &[Self::EdgeIndex])

Removes the edges with the given ids from the graph. The ids are expected to be given in sorted order. Read more
Source§

fn clear(&mut self)

Removes all nodes and edges from the graph.
Source§

fn remove_nodes_sorted_slice(&mut self, node_ids: &[Self::NodeIndex])

Removes all nodes with the given ids from the graph. The nodes must be passed as a slice and sorted in ascending order. Note that this may change the ids of existing nodes.
Source§

impl<NodeData, EdgeData> NavigableGraph for PetGraph<NodeData, EdgeData>

Source§

type OutNeighbors<'a> = Map<Edges<'a, EdgeData, Directed, usize>, fn(_: EdgeReference<'a, EdgeData, usize>) -> Neighbor<<PetGraph<NodeData, EdgeData> as GraphBase>::NodeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::EdgeIndex>> where NodeData: 'a, EdgeData: 'a

The iterator type used to iterate over the outgoing neighbors of a node.
Source§

type InNeighbors<'a> = Map<Edges<'a, EdgeData, Directed, usize>, fn(_: EdgeReference<'a, EdgeData, usize>) -> Neighbor<<PetGraph<NodeData, EdgeData> as GraphBase>::NodeIndex, <PetGraph<NodeData, EdgeData> as GraphBase>::EdgeIndex>> where NodeData: 'a, EdgeData: 'a

The iterator type used to iterate over the incoming neighbors of a node.
Source§

type EdgesBetween<'a> = Map<EdgesConnecting<'a, EdgeData, Directed, usize>, fn(_: EdgeReference<'a, EdgeData, usize>) -> <PetGraph<NodeData, EdgeData> as GraphBase>::EdgeIndex> where NodeData: 'a, EdgeData: 'a

The iterator type used to iterate over the edges between two nodes.
Source§

fn out_neighbors( &self, node_id: <Self as GraphBase>::NodeIndex, ) -> Self::OutNeighbors<'_>

Returns an iterator over the outgoing neighbors of the given node.
Source§

fn in_neighbors( &self, node_id: <Self as GraphBase>::NodeIndex, ) -> Self::InNeighbors<'_>

Returns an iterator over the incoming neighbors of the given node.
Source§

fn edges_between( &self, from_node_id: <Self as GraphBase>::NodeIndex, to_node_id: <Self as GraphBase>::NodeIndex, ) -> Self::EdgesBetween<'_>

Returns an iterator over the edges (from_node_id, to_node_id).
Source§

fn contains_edge_between( &self, from: Self::NodeIndex, to: Self::NodeIndex, ) -> bool

Returns true if the graph contains an edge (from, to).
Source§

fn edge_count_between( &self, from: Self::NodeIndex, to: Self::NodeIndex, ) -> usize

Returns the amount of edges (from, to).
Source§

fn out_degree(&self, node_id: Self::NodeIndex) -> usize

Returns the amount of outgoing edges from a node.
Source§

fn in_degree(&self, node_id: Self::NodeIndex) -> usize

Returns the amount of incoming edges to a node.
Source§

fn is_biunivocal_node(&self, node_id: Self::NodeIndex) -> bool

Returns true if the given node has indegree == 1 and outdegree == 1.
Source§

fn is_bivalent_node(&self, node_id: Self::NodeIndex) -> bool

Returns true if the given node has indegree > 1 and outdegree > 1.
Source§

fn is_split_edge(&self, edge_id: Self::EdgeIndex) -> bool

Returns true if the given edge’s tail has outdegree > 1.
Source§

fn is_join_edge(&self, edge_id: Self::EdgeIndex) -> bool

Returns true if the given edge’s head has indegree > 1.
Source§

fn is_split_node(&self, node_id: Self::NodeIndex) -> bool

Returns true if the given node has outdegree > 1.
Source§

fn is_join_node(&self, node_id: Self::NodeIndex) -> bool

Returns true if the given node has indegree > 1.
Source§

impl<NodeData: PartialEq, EdgeData: PartialEq> PartialEq for PetGraph<NodeData, EdgeData>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<NodeData, EdgeData> SubgraphBase for PetGraph<NodeData, EdgeData>

Source§

type RootGraph = PetGraph<NodeData, EdgeData>

The root graph of this subgraph, which is either its parent or the root of a DAG of subgraphs.
Source§

fn root(&self) -> &Self::RootGraph

Returns a reference to the root graph of this subgraph.
Source§

impl<NodeData: Eq, EdgeData: Eq> Eq for PetGraph<NodeData, EdgeData>

Auto Trait Implementations§

§

impl<NodeData, EdgeData> Freeze for PetGraph<NodeData, EdgeData>

§

impl<NodeData, EdgeData> RefUnwindSafe for PetGraph<NodeData, EdgeData>
where NodeData: RefUnwindSafe, EdgeData: RefUnwindSafe,

§

impl<NodeData, EdgeData> Send for PetGraph<NodeData, EdgeData>
where NodeData: Send, EdgeData: Send,

§

impl<NodeData, EdgeData> Sync for PetGraph<NodeData, EdgeData>
where NodeData: Sync, EdgeData: Sync,

§

impl<NodeData, EdgeData> Unpin for PetGraph<NodeData, EdgeData>
where NodeData: Unpin, EdgeData: Unpin,

§

impl<NodeData, EdgeData> UnwindSafe for PetGraph<NodeData, EdgeData>
where NodeData: UnwindSafe, EdgeData: UnwindSafe,

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, dst: *mut u8)

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

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
Source§

impl<Graph> WalkableGraph for Graph
where Graph: GraphBase,

Source§

fn create_node_walk<WalkType: NodeWalk<Self, SubwalkType> + FromIterator<Self::NodeIndex>, SubwalkType: NodeWalk<Self, SubwalkType> + ?Sized>( &self, walk: &[Self::NodeIndex], ) -> WalkType

Create a node-centric walk over the given nodes in this graph.
Source§

fn create_empty_node_walk<WalkType: NodeWalk<Self, SubwalkType> + Default, SubwalkType: NodeWalk<Self, SubwalkType> + ?Sized>( &self, ) -> WalkType

Create an empty node-centric walk in this graph.
Source§

fn create_edge_walk<WalkType: EdgeWalk<Self, SubwalkType> + FromIterator<Self::EdgeIndex>, SubwalkType: EdgeWalk<Self, SubwalkType> + ?Sized>( &self, walk: &[Self::EdgeIndex], ) -> WalkType

Create an edge-centric walk over the given edges in this graph.
Source§

fn create_empty_edge_walk<WalkType: EdgeWalk<Self, SubwalkType> + Default, SubwalkType: EdgeWalk<Self, SubwalkType> + ?Sized>( &self, ) -> WalkType

Create an empty edge-centric walk in this graph.
Source§

impl<T> DynamicGraph for T

Source§

impl<T> StaticGraph for T