Struct graph_types::UndirectedEdge

pub struct UndirectedEdge {
    pub from: usize,
    pub goto: usize,
}

UndirectedEdge represents an bidirectional edge between two nodes.

Examples

use graph_theory::GraphEngine;

Fields

from: usize

The index of the node that the edge is coming from, usually the smaller index.

goto: usize

The index of the node that the edge is going to, usually the larger index.

Implementations

impl UndirectedEdge

pub fn new(from: usize, goto: usize) -> Self

Creates a new edge from the given indices (start from 0).

pub fn as_range(&self) -> Range<usize>

Use the edge as a range.

Examples

use graph_theory::UndirectedEdge;
let range = UndirectedEdge::new(0, 3).as_range();
assert_eq!(range, 0..3);

Trait Implementations

impl Clone for UndirectedEdge

fn clone(&self) -> UndirectedEdge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UndirectedEdge

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

Formats the value using the given formatter.

impl Display for UndirectedEdge

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

Formats the value using the given formatter.

impl Edge for UndirectedEdge

fn direction(&self) -> EdgeDirection

Whether the edge is bidirectional

fn lhs(&self) -> usize

The left side node id of the edge

fn rhs(&self) -> usize

The right side node id of the edge

fn max_index(&self) -> usize

The smaller of the two indices.

fn min_index(&self) -> usize

The smaller of the two indices.

fn delta_index(&self) -> usize

The smaller of the two indices.

fn as_dynamic(&self) -> DynamicEdge

Creates a new edge with the indices swapped.

impl From<(usize, usize)> for UndirectedEdge

fn from(ordinal: (usize, usize)) -> Self

Creates a new edge from the given ordinals (start from 1).

impl From<UndirectedEdge> for EdgeQuery

fn from(edge: UndirectedEdge) -> Self

Converts to this type from the input type.

impl PartialEq<UndirectedEdge> for UndirectedEdge

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for UndirectedEdge

impl Eq for UndirectedEdge

impl StructuralEq for UndirectedEdge

impl StructuralPartialEq for UndirectedEdge