Struct h3ron_graph::graph::prepared::PreparedH3EdgeGraph

pub struct PreparedH3EdgeGraph<W> { /* private fields */ }

A prepared graph which can be used with a few algorithms.

Consequent H3DirectedEdges without forks get extended by a LongEdge to allow skipping the individual H3DirectedEdge values for a more efficient graph traversal.

Implementations

impl<W> PreparedH3EdgeGraph<W>

pub fn count_edges(&self) -> (usize, usize)

count the number of edges in the graph

The returned tuple is (num_edges, num_long_edges)

impl<W> PreparedH3EdgeGraph<W>where
    W: Copy,

pub fn iter_edges(
    &self
) -> impl Iterator<Item = (H3DirectedEdge, EdgeWeight<'_, W>)>

iterate over all edges of the graph

pub fn iter_edges_non_overlapping(
    &self
) -> Result<impl Iterator<Item = (H3DirectedEdge, EdgeWeight<'_, W>)>, Error>

iterate over all edges of the graph, while skipping simple H3DirectedEdge which are already covered in other LongEdge instances of the graph.

This function iterates the graph twice - the first time to collect all edges which are part of long-edges.

impl<W> PreparedH3EdgeGraph<W>where
    W: PartialOrd + PartialEq + Add + Copy + Ord + Zero + Send + Sync,

pub fn from_h3edge_graph(
    graph: H3EdgeGraph<W>,
    min_longedge_length: usize
) -> Result<Self, Error>

Trait Implementations

impl<W> BoundingRect<f64> for PreparedH3EdgeGraph<W>

type Output = Option<Rect<f64>>

fn bounding_rect(&self) -> Self::Output

Return the bounding rectangle of a geometry

impl<W: Clone> Clone for PreparedH3EdgeGraph<W>

fn clone(&self) -> PreparedH3EdgeGraph<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W> ConcaveHull for PreparedH3EdgeGraph<W>

fn concave_hull(&self, concavity: Self::Scalar) -> Polygon<Self::Scalar>

concave hull - this implementation leaves out invalid cells

type Scalar = f64

impl<W> CoveredArea for PreparedH3EdgeGraph<W>

type Error = Error

fn covered_area(
    &self,
    reduce_resolution_by: u8
) -> Result<MultiPolygon<f64>, Self::Error>

calculates a MultiPolygon of the area covered by a graph

impl<'de, W> Deserialize<'de> for PreparedH3EdgeGraph<W>where
    W: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<W> From<PreparedH3EdgeGraph<W>> for H3EdgeGraph<W>where
    W: PartialOrd + PartialEq + Add + Copy + Ord + Zero,

fn from(prepared_graph: PreparedH3EdgeGraph<W>) -> Self

Converts to this type from the input type.

impl<W: Copy> GetCellEdges for PreparedH3EdgeGraph<W>

type EdgeWeightType = W

fn get_edges_originating_from(
    &self,
    cell: &H3Cell
) -> Result<Vec<(H3DirectedEdge, EdgeWeight<'_, Self::EdgeWeightType>)>, Error>

get all edges and their values originating from cell cell

impl<W> GetCellNode for PreparedH3EdgeGraph<W>

fn get_cell_node(&self, cell: &H3Cell) -> Option<NodeType>

impl<W> GetStats for PreparedH3EdgeGraph<W>

fn get_stats(&self) -> Result<GraphStats, Error>

impl<W> HasH3Resolution for PreparedH3EdgeGraph<W>

fn h3_resolution(&self) -> u8

Gets the index resolution (0-15)

impl<'a, W> IterateCellNodes<'a> for PreparedH3EdgeGraph<W>

type CellNodeIterator = Iter<'a, H3Cell, NodeType>

fn iter_cell_nodes(&'a self) -> Self::CellNodeIterator

impl<W> Serialize for PreparedH3EdgeGraph<W>where
    W: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<W> TryFrom<H3EdgeGraph<W>> for PreparedH3EdgeGraph<W>where
    W: PartialOrd + PartialEq + Add + Copy + Ord + Zero + Send + Sync,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(graph: H3EdgeGraph<W>) -> Result<Self, Self::Error>

Performs the conversion.

impl<W> Sync for PreparedH3EdgeGraph<W>where
    W: Sync,