Struct graph_types::DirectedEdge

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

DirectedEdge represents an bidirectional edge between two nodes.

Also known as an arc.

Examples

use graph_theory::GraphEngine;

Fields

from: usize

The index of the node that the edge is coming from.

goto: usize

The index of the node that the edge is going to.

Implementations

impl DirectedEdge

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

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

Examples

use graph_theory::GraphEngine;

Trait Implementations

impl Clone for DirectedEdge

fn clone(&self) -> DirectedEdge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectedEdge

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

Formats the value using the given formatter.

impl Display for DirectedEdge

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

Formats the value using the given formatter.

impl Edge for DirectedEdge

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 DirectedEdge

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

Converts to this type from the input type.

impl From<DirectedEdge> for EdgeQuery

fn from(edge: DirectedEdge) -> Self

Converts to this type from the input type.

impl PartialEq<DirectedEdge> for DirectedEdge

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

impl Eq for DirectedEdge

impl StructuralEq for DirectedEdge

impl StructuralPartialEq for DirectedEdge