Struct DfsOptions 

pub struct DfsOptions {
    pub mode: NeighborMode,
    pub unreachable: bool,
}

Parameters of a depth-first search (Graph::dfs, Graph::dfs_with).

The defaults are: follow out-edges (NeighborMode::Out) and do not visit vertices unreachable from the root.

use igraph::prelude::*;
use igraph::visitor::DfsOptions;

// 0 -> 1, 2 -> 1: walking against the edges from 1 finds 0 and 2.
let g = Graph::from_edges(&[(0, 1), (2, 1)], 3, true)?;
let opts = DfsOptions::default().with_mode(NeighborMode::In);
assert_eq!(g.dfs(1, &opts)?.order, [1, 0, 2]);
assert_eq!(g.dfs(1, &DfsOptions::default())?.order, [1]);

Fields

mode: NeighborMode

Which edges to follow in directed graphs (see BfsOptions::mode). Ignored for undirected graphs.

unreachable: bool

If true, once the tree of the root is complete, further searches are started from the not yet visited vertices, in increasing id order.

Implementations

impl DfsOptions

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

Sets mode.

pub fn with_unreachable(self, unreachable: bool) -> Self

Sets unreachable.

Trait Implementations

impl Clone for DfsOptions

fn clone(&self) -> DfsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DfsOptions

impl Debug for DfsOptions

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

Formats the value using the given formatter.

impl Default for DfsOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DfsOptions

impl PartialEq for DfsOptions

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