Struct PointIndex 

pub struct PointIndex<M: Clone + Default + Serialize + DeserializeOwned = MValue, S: VectorStore<S2CellId, IndexPoint<M>> = Vector<S2CellId, IndexPoint<M>>> { /* private fields */ }

Point Index

Description

An index of cells with radius queries Assumes the data is compatible with S2JSON MValues with serde_json serialization

Implementations

impl<M: Clone + Default + Serialize + DeserializeOwned, S: VectorStore<S2CellId, IndexPoint<M>>> PointIndex<M, S>

pub fn new(store: Option<S>, projection: Option<Projection>) -> Self

Create a new PointIndex

pub fn len(&self) -> u64

Returns the number of points in the index

pub fn is_empty(&self) -> bool

Returns true if the index is empty

pub fn get_index(&self, index: u64) -> Option<&(S2CellId, IndexPoint<M>)>

Get a reference to the point store

pub fn get_index_mut( &mut self, index: u64, ) -> Option<&mut (S2CellId, IndexPoint<M>)>

Get a mutable reference to the point store

pub fn insert(&mut self, cell: S2CellId, point: S2Point, data: Option<M>)

Insert a cell with the point and its corresponding data to the index

pub fn insert_point<T: GetXY>(&mut self, point: T, data: Option<M>)

Add a lon-lat pair as with any shape

pub fn insert_lon_lat(&mut self, vp: LonLat<M>)

Add a lon-lat pair to the cluster

pub fn insert_vector_point(&mut self, vp: VectorPoint<M>)

Add a lon-lat pair via a VectorPoint to the cluster

pub fn insert_face_st(&mut self, face: Face, s: f64, t: f64, data: M)

Insert an STPoint to the index

pub fn insert_reader<T: Clone, F: FeatureReader<T, M, M>>(&mut self, reader: &F)

Add all points from a reader. It will try to use the M-value first, but if it doesn’t exist it will use the feature properties data

pub fn insert_feature<T: Clone>(&mut self, data: JSONCollection<T, M, M>)

Add a vector feature. It will try to use the M-value first, but if it doesn’t exist it will use the feature properties data

pub fn sort(&mut self)

Sort the index

pub fn lower_bound(&self, id: S2CellId) -> u64

Find the starting index of a search

pub fn search_range( &self, low: S2CellId, high: Option<S2CellId>, max_results: Option<usize>, ) -> Vec<&(S2CellId, IndexPoint<M>)>

Search for points given a range of low and high ids

pub fn search_range_mut( &mut self, low: S2CellId, high: Option<S2CellId>, max_results: Option<usize>, ) -> Vec<&mut (S2CellId, IndexPoint<M>)>

Search for points given a range of low and high ids

pub fn search_radius<M2: Clone + Default>( &self, target: &LonLat<M2>, radius: S1ChordAngle, max_results: Option<usize>, ) -> Vec<&(S2CellId, IndexPoint<M>)>

TODO: WG Proj case: is the radius correct? Search for points within a given radius of a target point

pub fn s2_search_radius( &self, target: S2Point, radius: S1ChordAngle, max_results: Option<usize>, ) -> Vec<&(S2CellId, IndexPoint<M>)>

Search for points within a given radius of a target point in S2 space

pub fn search_radius_mut<M2: Clone + Default>( &mut self, target: &LonLat<M2>, radius: S1ChordAngle, max_results: Option<usize>, ) -> Vec<&mut (S2CellId, IndexPoint<M>)>

TODO: WG Proj case: is the radius correct? Search for points within a given radius of a target point

pub fn s2_search_radius_mut( &mut self, target: S2Point, radius: S1ChordAngle, max_results: Option<usize>, ) -> Vec<&mut (S2CellId, IndexPoint<M>)>

Search for points within a given radius of a target point in S2 space

pub fn iter<'a>(&'a self) -> impl Iterator<Item = &'a (S2CellId, IndexPoint<M>)>

where IndexPoint<M>: 'a,

Get a reference iterator over the point store

pub fn iter_mut<'a>( &'a mut self, ) -> impl Iterator<Item = &'a mut (S2CellId, IndexPoint<M>)>

where IndexPoint<M>: 'a,

Get a mutable iterator over the point store

Trait Implementations

impl<M: Debug + Clone + Default + Serialize + DeserializeOwned, S: Debug + VectorStore<S2CellId, IndexPoint<M>>> Debug for PointIndex<M, S>

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

Formats the value using the given formatter.

impl<M: Default + Clone + Default + Serialize + DeserializeOwned, S: Default + VectorStore<S2CellId, IndexPoint<M>>> Default for PointIndex<M, S>

fn default() -> PointIndex<M, S>

Returns the “default value” for a type.