Struct petgraph::visit::EdgeFiltered

pub struct EdgeFiltered<G, F>(pub G, pub F);

An edge-filtering graph adaptor.

The adaptor may filter out edges. The filter implements the trait FilterEdge. Closures of type Fn(G::EdgeRef) -> bool already implement this trait.

The filter may use edge source, target, id, and weight to select whether to include the edge or not.

Tuple Fields

0: G

1: F

Implementations

impl<F, G> EdgeFiltered<G, F> where
    G: IntoEdgeReferences,
    F: Fn(G::EdgeRef) -> bool, 

pub fn from_fn(graph: G, filter: F) -> Self

Create an EdgeFiltered adaptor from the closure filter.

Trait Implementations

impl<G: Clone, F: Clone> Clone for EdgeFiltered<G, F>

fn clone(&self) -> EdgeFiltered<G, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G, F> Data for EdgeFiltered<G, F> where
    G: Data, 

type NodeWeight = G::NodeWeight

type EdgeWeight = G::EdgeWeight

impl<G: Debug, F: Debug> Debug for EdgeFiltered<G, F>

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

Formats the value using the given formatter.

impl<G, F> EdgeIndexable for EdgeFiltered<G, F> where
    G: EdgeIndexable, 

fn edge_bound(&self) -> usize

Return an upper bound of the edge indices in the graph (suitable for the size of a bitmap).

fn to_index(&self, a: Self::EdgeId) -> usize

Convert a to an integer index.

fn from_index(&self, i: usize) -> Self::EdgeId

Convert i to an edge index. i must be a valid value in the graph.

impl<G, F> GraphBase for EdgeFiltered<G, F> where
    G: GraphBase, 

type NodeId = G::NodeId

node identifier

type EdgeId = G::EdgeId

edge identifier

impl<G, F> GraphProp for EdgeFiltered<G, F> where
    G: GraphProp, 

type EdgeType = G::EdgeType

The kind edges in the graph.

fn is_directed(&self) -> bool

impl<'a, G, F> IntoEdgeReferences for &'a EdgeFiltered<G, F> where
    G: IntoEdgeReferences,
    F: FilterEdge<G::EdgeRef>, 

type EdgeRef = G::EdgeRef

type EdgeReferences = EdgeFilteredEdges<'a, G, G::EdgeReferences, F>

fn edge_references(self) -> Self::EdgeReferences

impl<'a, G, F> IntoEdges for &'a EdgeFiltered<G, F> where
    G: IntoEdges,
    F: FilterEdge<G::EdgeRef>, 

type Edges = EdgeFilteredEdges<'a, G, G::Edges, F>

fn edges(self, n: G::NodeId) -> Self::Edges

impl<'a, G, F> IntoEdgesDirected for &'a EdgeFiltered<G, F> where
    G: IntoEdgesDirected,
    F: FilterEdge<G::EdgeRef>, 

type EdgesDirected = EdgeFilteredEdges<'a, G, G::EdgesDirected, F>

fn edges_directed(self, n: G::NodeId, dir: Direction) -> Self::EdgesDirected

impl<'a, G, F> IntoNeighbors for &'a EdgeFiltered<G, F> where
    G: IntoEdges,
    F: FilterEdge<G::EdgeRef>, 

type Neighbors = EdgeFilteredNeighbors<'a, G, F>

fn neighbors(self, n: G::NodeId) -> Self::Neighbors

Return an iterator of the neighbors of node a.

impl<'a, G, F> IntoNeighborsDirected for &'a EdgeFiltered<G, F> where
    G: IntoEdgesDirected,
    F: FilterEdge<G::EdgeRef>, 

type NeighborsDirected = EdgeFilteredNeighborsDirected<'a, G, F>

fn neighbors_directed(
    self,
    n: G::NodeId,
    dir: Direction
) -> Self::NeighborsDirected

impl<'a, G, F> IntoNodeIdentifiers for &'a EdgeFiltered<G, F> where
    G: IntoNodeIdentifiers, 

type NodeIdentifiers = G::NodeIdentifiers

fn node_identifiers(self) -> Self::NodeIdentifiers

impl<'a, G, F> IntoNodeReferences for &'a EdgeFiltered<G, F> where
    G: IntoNodeReferences, 

type NodeRef = G::NodeRef

type NodeReferences = G::NodeReferences

fn node_references(self) -> Self::NodeReferences

impl<G, F> NodeCount for EdgeFiltered<G, F> where
    G: NodeCount, 

fn node_count(&self) -> usize

impl<G, F> NodeIndexable for EdgeFiltered<G, F> where
    G: NodeIndexable, 

fn node_bound(&self) -> usize

Return an upper bound of the node indices in the graph (suitable for the size of a bitmap).

fn to_index(&self, a: Self::NodeId) -> usize

Convert a to an integer index.

fn from_index(&self, i: usize) -> Self::NodeId

Convert i to a node index. i must be a valid value in the graph.

impl<G, F> Visitable for EdgeFiltered<G, F> where
    G: Visitable, 

type Map = G::Map

The associated map type

fn visit_map(&self) -> Self::Map

Create a new visitor map

fn reset_map(&self, map: &mut Self::Map)

Reset the visitor map (and resize to new size of graph if needed)

impl<G: Copy, F: Copy> Copy for EdgeFiltered<G, F>

impl<G, F> NodeCompactIndexable for EdgeFiltered<G, F> where
    G: NodeCompactIndexable,