Struct SimpleCyclesOptions 

pub struct SimpleCyclesOptions {
    pub mode: NeighborMode,
    pub min_cycle_length: Option<usize>,
    pub max_cycle_length: Option<usize>,
    pub max_results: Option<usize>,
}

Options for Graph::simple_cycles and Graph::simple_cycles_callback.

The default searches for all simple cycles of any length, following edge directions (NeighborMode::Out) in directed graphs. Lengths count edges, which for simple cycles equals the number of vertices.

use igraph::{cycles::SimpleCyclesOptions, prelude::*};
let opts = SimpleCyclesOptions::default().with_max_length(4).with_max_results(10);
assert_eq!(opts.max_cycle_length, Some(4));
assert_eq!(opts.mode, NeighborMode::Out);

Fields

mode: NeighborMode

How edge directions are considered in directed graphs: Out follows them, In follows them backwards, All ignores them. Ignored for undirected graphs. Default: Out.

min_cycle_length: Option<usize>

Only report cycles with at least this many edges (None: no limit).

max_cycle_length: Option<usize>

Only report cycles with at most this many edges (None: no limit). Bounding the length also bounds the search, making it much faster.

max_results: Option<usize>

Stop after this many cycles have been reported (None: no limit).

Implementations

impl SimpleCyclesOptions

pub fn with_mode(self, mode: NeighborMode) -> Self

Sets mode.

pub fn with_min_length(self, len: usize) -> Self

Sets min_cycle_length.

pub fn with_max_length(self, len: usize) -> Self

Sets max_cycle_length.

pub fn with_max_results(self, n: usize) -> Self

Sets max_results.

Trait Implementations

impl Clone for SimpleCyclesOptions

fn clone(&self) -> SimpleCyclesOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SimpleCyclesOptions

impl Debug for SimpleCyclesOptions

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

Formats the value using the given formatter.

impl Default for SimpleCyclesOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SimpleCyclesOptions

impl PartialEq for SimpleCyclesOptions

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