Struct BipartiteGraph 

pub struct BipartiteGraph {
    pub graph: Graph,
    pub types: Vec<bool>,
}

A graph together with its vertex types: the output of the bipartite constructors and generators of this module.

Vertices with type false form the first class, vertices with type true the second one. The fields are public: take them apart freely (or use into_parts).

Fields

graph: Graph

The graph.

types: Vec<bool>

The type of each vertex, indexed by vertex id.

Implementations

impl BipartiteGraph

pub fn new( types: Vec<bool>, edges: &[(VertexId, VertexId)], directed: bool, ) -> Result<Self>

Creates a bipartite graph from vertex types and a list of edges, checking that every edge connects vertices of different types (igraph_create_bipartite).

The number of vertices is types.len(). See Graph::create_bipartite.

Errors

ErrorKind::InvalidValue if an edge joins two vertices of the same type, or ErrorKind::InvalidVertexId if an endpoint is out of range.

Examples

use igraph::bipartite::BipartiteGraph;
let b = BipartiteGraph::new(vec![false, true, false], &[(0, 1), (2, 1)], false).unwrap();
assert_eq!(b.part(true), vec![1]);
assert!(BipartiteGraph::new(vec![false, false], &[(0, 1)], false).is_err());

pub fn from_graph(graph: Graph) -> Result<Option<Self>>

Wraps graph with a 2-coloring found by Graph::bipartite_types, or returns Ok(None) if the graph is not bipartite.

Examples

use igraph::{bipartite::BipartiteGraph, prelude::*};
let square = Graph::from_edges(&[(0, 1), (1, 2), (2, 3), (3, 0)], 4, false).unwrap();
let b = BipartiteGraph::from_graph(square).unwrap().unwrap();
assert_eq!(b.types, vec![false, true, false, true]);
let triangle = Graph::from_edges(&[(0, 1), (1, 2), (2, 0)], 3, false).unwrap();
assert!(BipartiteGraph::from_graph(triangle).unwrap().is_none());

pub fn into_parts(self) -> (Graph, Vec<bool>)

Splits self into the graph and its types.

pub fn part(&self, kind: bool) -> Vec<VertexId>

The ids of the vertices having type kind, in increasing order.

pub fn part_sizes(&self) -> (usize, usize)

The number of vertices of type false and of type true.

pub fn projection(&self) -> Result<BipartiteProjection>

Both one-mode projections, see Graph::bipartite_projection.

pub fn biadjacency(&self, weights: Option<&[f64]>) -> Result<Biadjacency>

The bipartite adjacency matrix, see Graph::get_biadjacency.

pub fn maximum_matching( &self, weights: Option<&[f64]>, ) -> Result<BipartiteMatching>

A maximum (weighted) matching, see Graph::maximum_bipartite_matching.

Trait Implementations

impl Clone for BipartiteGraph

fn clone(&self) -> BipartiteGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BipartiteGraph

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

Formats the value using the given formatter.

impl PartialEq for BipartiteGraph

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BipartiteGraph