Skip to main content

DrainageGraph

Struct DrainageGraph 

Source
pub struct DrainageGraph { /* private fields */ }
Expand description

The complete upstream adjacency graph over drainage units.

This is the canonical in-memory representation of graph.parquet for validation and construction purposes. The HashMap-based index provides O(1) lookup by unit ID.

Note for engine implementors: this representation is optimized for validation and random access, not traversal. A delineation engine will typically convert to CSR (compressed sparse row) or another traversal-optimized layout at load time, as permitted by the HFX spec.

Implementations§

Source§

impl DrainageGraph

Source

pub fn new(rows: Vec<AdjacencyRow>) -> Result<Self, GraphError>

Construct a DrainageGraph from a vector of AdjacencyRows.

Builds the internal O(1) lookup index as part of construction.

§Errors
ConditionError variant
rows is emptyGraphError::EmptyGraph
The same UnitId appears in two or more rowsGraphError::DuplicateUnitId
Source

pub fn rows(&self) -> &[AdjacencyRow]

Return all rows in the graph.

Source

pub fn len(&self) -> usize

Return the number of rows in the graph.

Source

pub fn is_empty(&self) -> bool

Return true if the graph contains no rows.

Source

pub fn get(&self, id: UnitId) -> Option<&AdjacencyRow>

Look up a row by UnitId in O(1) time.

Returns None if no row with the given ID exists in the graph.

Trait Implementations§

Source§

impl Clone for DrainageGraph

Source§

fn clone(&self) -> DrainageGraph

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DrainageGraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for DrainageGraph

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DrainageGraph

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.