Struct Complement 

pub struct Complement<E, G> { /* private fields */ }

The complement of an undirected graph, that is, a graph with the same vertices but they are connected if and only if they were not connected in the original graph.

Examples

use gryf::{Graph, adapt::Complement, core::Neighbors};

let mut graph = Graph::new_undirected();

let v0 = graph.add_vertex(());
let v1 = graph.add_vertex(());
let v2 = graph.add_vertex(());

graph.add_edge(&v0, &v1, "original");

assert_eq!(graph.edge_count(), 1);

let neighbor = graph.neighbors_undirected(&v0).next().unwrap();
assert_eq!(neighbor.id, v1);
assert_eq!(graph.edge(&neighbor.edge), Some(&"original"));

// Create graph complement.
let complement = Complement::new(graph, "complement");

assert_eq!(complement.edge_count(), 2);

let neighbor = complement.neighbors_undirected(&v0).next().unwrap();
assert_eq!(neighbor.id, v2);
assert_eq!(complement.edge(&neighbor.edge), Some(&"complement"));

Implementations

impl<E, G> Complement<E, G>

where G: GraphBase<EdgeType = Undirected> + VertexSet + EdgeSet,

pub fn new(graph: G, edge: E) -> Self

Creates a complement of the given graph, using edge value for all complement edges.

pub fn into_inner(self) -> G

Consumes the adapter and returns the wrapped graph.

pub fn edge_count(&self) -> usize

Returns the number of edges in the graph.

pub fn edge<EI>(&self, id: EI) -> Option<&E>

where EI: AsIdRef<G::EdgeId>,

Returns a reference to the edge attribute, if it exists.

Trait Implementations

impl<E: Debug, G: Debug> Debug for Complement<E, G>

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

Formats the value using the given formatter.

impl<E, G> GraphBase for Complement<E, G>

where G: GraphBase,

type VertexId = <G as GraphBase>::VertexId

Vertex ID type of the graph.

type EdgeId = <G as GraphBase>::EdgeId

Edge ID type of the graph.

type EdgeType = <G as GraphBase>::EdgeType

Directionality of the graph.

fn vertex_count_hint(&self) -> Option<usize>

Returns the upper bound of the vertex count, if available.

fn edge_count_hint(&self) -> Option<usize>

Returns the upper bound of the edge count, if available.

fn is_directed(&self) -> bool

Returns true if the graph is directed.

impl<E, G> Neighbors for Complement<E, G>

where G: Neighbors + VertexSet, G::EdgeId: IntegerIdType,

type NeighborRef<'a> = NeighborRef<<G as GraphBase>::VertexId, <G as GraphBase>::EdgeId> where Self: 'a

Reference to a neighbor.

type NeighborsIter<'a> = NeighborsIter<'a, G> where Self: 'a

Iterator over neighbors of a vertex.

fn neighbors_undirected(&self, from: &G::VertexId) -> Self::NeighborsIter<'_>

Returns all neighbors of the given vertex, regardless of edge direction.

fn neighbors_directed( &self, from: &G::VertexId, dir: Direction, ) -> Self::NeighborsIter<'_>

Returns all neighbors of the given vertex in the given direction.

fn degree_undirected(&self, id: &Self::VertexId) -> usize

Returns the total degree of the given vertex.

fn degree_directed(&self, id: &Self::VertexId, dir: Direction) -> usize

Returns the out or in degree of the given vertex, depending on the edge direction argument.

impl<E, G> VertexSet for Complement<E, G>

where G: VertexSet,

type VerticesByIdIter<'a> = <G as VertexSet>::VerticesByIdIter<'a> where Self: 'a

Iterator over vertex IDs.

fn vertices_by_id(&self) -> Self::VerticesByIdIter<'_>

Returns all vertices in the graph.

fn vertex_count(&self) -> usize

Returns the number of vertices in the graph.

fn vertex_bound(&self) -> usize

where Self::VertexId: IntegerIdType,

Returns the highest vertex ID currently in use.

fn contains_vertex(&self, id: &Self::VertexId) -> bool

Returns true if the graph contains the given vertex.

fn vertex_id_map(&self) -> CompactIdMap<Self::VertexId>

Returns a mapping of vertex IDs to virtual IDs representing a contiguous sequence.