Struct MinimumCycleBasisOptions 

pub struct MinimumCycleBasisOptions {
    pub bfs_cutoff: Option<usize>,
    pub complete: bool,
    pub use_cycle_order: bool,
}

Options for Graph::minimum_cycle_basis.

The default computes an exact minimum cycle basis with each cycle listed in cycle order (bfs_cutoff: None, complete: true, use_cycle_order: true), the same defaults as the igraph R and Python interfaces.

use igraph::cycles::MinimumCycleBasisOptions;
let fast = MinimumCycleBasisOptions::default().with_bfs_cutoff(3).with_complete(false);
assert_eq!(fast.bfs_cutoff, Some(3));
assert!(fast.use_cycle_order);

Fields

bfs_cutoff: Option<usize>

None computes an exact minimum basis. Some(k) limits the depth of the BFS trees used to generate candidate cycles, which can speed up the computation substantially: then only the returned cycles of length at most 2k + 1 are guaranteed to belong to some minimum basis. Default: None.

complete: bool

Only used with a bfs_cutoff. If true, a complete basis is still returned (its cycles longer than 2k + 1 may not be minimal); if false, only the cycles of length at most 2k + 1 are returned, which is faster but does not span the whole cycle space. Default: true.

use_cycle_order: bool

If true, the edge ids of each cycle are listed in the order they appear along the cycle (at a small cost); if false, their order is unspecified. Default: true.

Implementations

impl MinimumCycleBasisOptions

pub fn with_bfs_cutoff(self, k: usize) -> Self

Sets bfs_cutoff to Some(k).

pub fn with_complete(self, complete: bool) -> Self

Sets complete.

pub fn with_cycle_order(self, use_cycle_order: bool) -> Self

Sets use_cycle_order.

Trait Implementations

impl Clone for MinimumCycleBasisOptions

fn clone(&self) -> MinimumCycleBasisOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MinimumCycleBasisOptions

impl Debug for MinimumCycleBasisOptions

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

Formats the value using the given formatter.

impl Default for MinimumCycleBasisOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MinimumCycleBasisOptions

impl PartialEq for MinimumCycleBasisOptions

fn eq(&self, other: &MinimumCycleBasisOptions) -> 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 MinimumCycleBasisOptions