Skip to main content

BipartiteGameOptions

Struct BipartiteGameOptions 

Source
pub struct BipartiteGameOptions {
    pub directed: bool,
    pub mode: NeighborMode,
    pub allowed_edge_types: EdgeTypeSw,
    pub edge_labeled: bool,
}
Expand description

Parameters shared by the random bipartite generators Graph::bipartite_game_gnp and Graph::bipartite_game_gnm.

The default is an undirected simple graph from the classic (edge-unlabeled) Erdős–Rényi model.

Fields§

§directed: bool

Whether to generate a directed graph (default false).

§mode: NeighborMode

Direction of the edges in directed graphs (default NeighborMode::Out): Out points from bottom (type false) to top (type true) vertices, In the other way around; with All each edge direction is sampled independently, so mutual edges may appear. Ignored if undirected.

§allowed_edge_types: EdgeTypeSw

Allowed edge types (default EdgeTypeSw::Simple): use EdgeTypeSw::Multi to allow multi-edges. Self-loops are never possible in a bipartite graph, so EdgeTypeSw::Loops is the same as EdgeTypeSw::Simple.

§edge_labeled: bool

If true, sample uniformly from ordered edge lists (edge-labeled graphs) instead of the classic model (default false). Only relevant when multi-edges are allowed: with simple graphs, Graph::bipartite_game_gnm only shuffles the edge order and Graph::bipartite_game_gnp fails with ErrorKind::Unimplemented.

Implementations§

Source§

impl BipartiteGameOptions

Source

pub fn with_directed(self, directed: bool, mode: NeighborMode) -> Self

Sets directed and mode.

Source

pub fn with_allowed_edge_types(self, allowed: EdgeTypeSw) -> Self

Source

pub fn with_edge_labeled(self, edge_labeled: bool) -> Self

Trait Implementations§

Source§

impl Clone for BipartiteGameOptions

Source§

fn clone(&self) -> BipartiteGameOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BipartiteGameOptions

Source§

impl Debug for BipartiteGameOptions

Source§

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

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

impl Default for BipartiteGameOptions

Source§

fn default() -> Self

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

impl Eq for BipartiteGameOptions

Source§

impl PartialEq for BipartiteGameOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for BipartiteGameOptions

Auto Trait Implementations§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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, 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.