Struct petgraph::visit::EdgeFiltered[−][src]

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

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.

Implementations

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

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

Create an EdgeFiltered adaptor from the closure filter.

Trait Implementations

impl<G: Clone, F: Clone> Clone for EdgeFiltered<G, F>[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<G, F> Data for EdgeFiltered<G, F> where
    G: Data, [src]

type NodeWeight = G::NodeWeight

type EdgeWeight = G::EdgeWeight

impl<G: Debug, F: Debug> Debug for EdgeFiltered<G, F>[src]

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

Formats the value using the given formatter. Read more

impl<G, F> GraphBase for EdgeFiltered<G, F> where
    G: GraphBase, [src]

type NodeId = G::NodeId

node identifier

type EdgeId = G::EdgeId

edge identifier

impl<G, F> GraphProp for EdgeFiltered<G, F> where
    G: GraphProp, [src]

type EdgeType = G::EdgeType

The kind edges in the graph.

fn is_directed(&self) -> bool[src]

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

type EdgeRef = G::EdgeRef

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

fn edge_references(self) -> Self::EdgeReferences[src]

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

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

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

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

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

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

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>, [src]

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

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

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

type NodeIdentifiers = G::NodeIdentifiers

fn node_identifiers(self) -> Self::NodeIdentifiers[src]

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

type NodeRef = G::NodeRef

type NodeReferences = G::NodeReferences

fn node_references(self) -> Self::NodeReferences[src]

impl<G, F> NodeCount for EdgeFiltered<G, F> where
    G: NodeCount, [src]

fn node_count(&self) -> usize[src]

impl<G, F> NodeIndexable for EdgeFiltered<G, F> where
    G: NodeIndexable, [src]

fn node_bound(&self) -> usize[src]

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

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

Convert a to an integer index.

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

Convert i to a node index

impl<G, F> Visitable for EdgeFiltered<G, F> where
    G: Visitable, [src]

type Map = G::Map

The associated map type

fn visit_map(&self) -> Self::Map[src]

Create a new visitor map

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

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

impl<G: Copy, F: Copy> Copy for EdgeFiltered<G, F>[src]

impl<G, F> NodeCompactIndexable for EdgeFiltered<G, F> where
    G: NodeCompactIndexable, [src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.