FlowEdge

Struct FlowEdge 

Source
pub struct FlowEdge {
    pub to: usize,
    pub capacity: f64,
    pub flow: f64,
    pub rev: usize,
}
Expand description

A single directed edge in a flow network.

Each edge stores its target node, capacity, current flow, and — crucially — the index of its reverse edge in the adjacency list of the target node. This reverse-index pattern is the standard safe Rust approach to residual graph updates: instead of holding two mutable references simultaneously, we use indices to locate and update both the forward and backward edges.

Fields§

§to: usize

Destination node index.

§capacity: f64

Maximum capacity of this edge.

§flow: f64

Current flow along this edge.

§rev: usize

Index of the reverse (residual) edge in adjacency[to].

When we send flow along edge (u→v), we simultaneously increase the residual capacity of (v→u) by indexing: adjacency[to][rev].

Implementations§

Source§

impl FlowEdge

Source

pub fn residual(&self) -> f64

Returns the residual capacity of this edge: how much more flow can be pushed along it.

For a forward edge this is capacity - flow. For a reverse (residual) edge this equals the flow already sent on the corresponding forward edge.

§Examples
use graph_flow::flow_graph::FlowEdge;

let edge = FlowEdge { to: 1, capacity: 10.0, flow: 3.0, rev: 0 };
assert_eq!(edge.residual(), 7.0);

Trait Implementations§

Source§

impl Clone for FlowEdge

Source§

fn clone(&self) -> FlowEdge

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlowEdge

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.