ExcludeCells

h3ron_graph::graph::modifiers

Struct ExcludeCells 

Source 
pub struct ExcludeCells<'a, G, W> { /* private fields */ }
Expand description

wrapper to exclude cells from traversal during routing

Implementations§

Source§

impl<'a, G, W> ExcludeCells<'a, G, W>
where G: GetCellNode + GetCellEdges<EdgeWeightType = W> + HasH3Resolution,

Source

pub fn new(inner_graph: &'a G, cells_to_exclude: &'a H3Treemap<H3Cell>) -> Self

Trait Implementations§

Source§

impl<'a, G, W> GetCellEdges for ExcludeCells<'a, G, W>
where G: GetCellEdges<EdgeWeightType = W>,

Source§

type EdgeWeightType = <G as GetCellEdges>::EdgeWeightType

Source§

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
Source§

impl<'a, G, W> GetCellNode for ExcludeCells<'a, G, W>
where G: GetCellNode,

Source§

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

Source§

impl<'a, G, W> HasH3Resolution for ExcludeCells<'a, G, W>
where G: HasH3Resolution,

Source§

fn h3_resolution(&self) -> u8

Gets the index resolution (0-15)

Auto Trait Implementations§

§

impl<'a, G, W> Freeze for ExcludeCells<'a, G, W>

§

impl<'a, G, W> RefUnwindSafe for ExcludeCells<'a, G, W>
where G: RefUnwindSafe, W: RefUnwindSafe,

§

impl<'a, G, W> Send for ExcludeCells<'a, G, W>
where G: Sync, W: Send,

§

impl<'a, G, W> Sync for ExcludeCells<'a, G, W>
where G: Sync, W: Sync,

§

impl<'a, G, W> Unpin for ExcludeCells<'a, G, W>
where W: Unpin,

§

impl<'a, G, W> UnwindSafe for ExcludeCells<'a, G, W>
where G: RefUnwindSafe, W: UnwindSafe,

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<G, W> DifferentialShortestPath<W> for G
where W: PartialOrd + PartialEq + Add + Copy + Send + Ord + Zero + Sync, G: GetCellEdges<EdgeWeightType = W> + GetCellNode + HasH3Resolution + NearestGraphNodes + Sync + ShortestPathManyToMany<W>,

Source§

fn differential_shortest_path_map<I, OPT, PM, O>( &self, origin_cells: I, destination_cells: I, exclude_cells: &H3Treemap<H3Cell>, options: &OPT, path_transform_fn: PM, ) -> Result<HashMap<H3Cell, ExclusionDiff<O>, RandomState>, Error>
where I: IntoIterator, <I as IntoIterator>::Item: Borrow<H3Cell>, OPT: ShortestPathOptions + Send + Sync, O: Send + Ord + Clone, PM: Fn(Path<W>) -> Result<O, Error> + Send + Sync,

Source§

fn differential_shortest_path<I, OPT>( &self, origin_cells: I, destination_cells: I, exclude_cells: &H3Treemap<H3Cell>, options: &OPT, ) -> Result<HashMap<H3Cell, ExclusionDiff<Path<W>>>, Error>
where I: IntoIterator, I::Item: Borrow<H3Cell>, OPT: ShortestPathOptions + Send + Sync,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<G> GetEdge for G
where G: GetCellEdges,

Source§

type EdgeWeightType = <G as GetCellEdges>::EdgeWeightType

Source§

fn get_edge( &self, edge: &H3DirectedEdge, ) -> Result<Option<EdgeWeight<'_, <G as GetEdge>::EdgeWeightType>>, Error>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<G> NearestGraphNodes for G
where G: GetCellNode,

Source§

fn nearest_graph_nodes( &self, cell: &H3Cell, max_distance_k: u32, ) -> Result<NearestGraphNodesGetCellIter<'_, G>, Error>

get an iterator over the closest corresponding nodes in the graph to the given cell. The iterator will return all nodes with the same, smallest k <= max_distance_k which are part of the graph.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<W, G> ShortestPath<W> for G
where G: GetCellEdges<EdgeWeightType = W> + GetCellNode + HasH3Resolution + NearestGraphNodes, W: PartialOrd + PartialEq + Add + Copy + Ord + Zero,

Source§

fn shortest_path<I, OPT>( &self, origin_cell: H3Cell, destination_cells: I, options: &OPT, ) -> Result<Vec<Path<W>>, Error>
where I: IntoIterator, <I as IntoIterator>::Item: Borrow<H3Cell>, OPT: ShortestPathOptions,

Source§

impl<W, G> ShortestPathManyToMany<W> for G
where G: GetCellEdges<EdgeWeightType = W> + GetCellNode + HasH3Resolution + NearestGraphNodes + Sync, W: PartialOrd + PartialEq + Add + Copy + Send + Ord + Zero + Sync,

Source§

fn shortest_path_many_to_many_map<I, OPT, PM, O>( &self, origin_cells: I, destination_cells: I, options: &OPT, path_transform_fn: PM, ) -> Result<HashMap<H3Cell, Vec<O>, RandomState>, Error>
where I: IntoIterator, <I as IntoIterator>::Item: Borrow<H3Cell>, OPT: ShortestPathOptions + Send + Sync, PM: Fn(Path<W>) -> Result<O, Error> + Send + Sync, O: Send + Ord + Clone,

Returns found paths, transformed by the path_map_fn and keyed by the origin cell. Read more
Source§

fn shortest_path_many_to_many<I, OPT>( &self, origin_cells: I, destination_cells: I, options: &OPT, ) -> Result<H3CellMap<Vec<Path<W>>>, Error>
where I: IntoIterator, I::Item: Borrow<H3Cell>, OPT: ShortestPathOptions + Send + Sync,

Returns found paths keyed by the origin cell. 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.
Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<W, G> WithinWeightThreshold<W> for G
where G: GetCellEdges<EdgeWeightType = W>, W: Zero + Ord + Copy + Add,

Source§

fn cells_within_weight_threshold( &self, origin_cell: H3Cell, weight_threshold: W, ) -> Result<HashMap<H3Cell, W, RandomState>, Error>

Find all cells connected to the graph within a given weight_threshold around the given origin_cell
Source§

impl<W, G> WithinWeightThresholdMany<W> for G
where G: GetCellEdges<EdgeWeightType = W> + WithinWeightThreshold<W> + Sync, W: Zero + Ord + Copy + Add + Send + Sync,

Source§

fn cells_within_weight_threshold_many<I, AGG>( &self, origin_cells: I, weight_threshold: W, agg_fn: AGG, ) -> Result<HashMap<H3Cell, W, RandomState>, Error>
where I: IntoParallelIterator, <I as IntoParallelIterator>::Item: Borrow<H3Cell>, AGG: Fn(&mut W, W) + Sync,

Find all cells connected to the graph within a given weight_threshold around the given origin_cells. Read more