Struct rstar::primitives::PointWithData
source · pub struct PointWithData<T, P> {
pub data: T,
/* private fields */
}
Expand description
A point with some associated data that can be inserted into an r-tree.
Note: PointWithData
has been deprecated in favour of GeomWithData
Often, adding metadata (like a database index) to a point is required before adding them into an r-tree. This struct removes some of the boilerplate required to do so.
Example
use rstar::{RTree, PointDistance};
use rstar::primitives::PointWithData;
type RestaurantLocation = PointWithData<&'static str, [f64; 2]>;
let mut restaurants = RTree::new();
restaurants.insert(RestaurantLocation::new("Pete's Pizza Place", [0.3, 0.2]));
restaurants.insert(RestaurantLocation::new("The Great Steak", [-0.8, 0.0]));
restaurants.insert(RestaurantLocation::new("Fishy Fortune", [0.2, -0.2]));
let my_location = [0.0, 0.0];
// Now find the closest restaurant!
let place = restaurants.nearest_neighbor(&my_location).unwrap();
println!("Let's go to {}", place.data);
println!("It's really close, only {} miles", place.distance_2(&my_location))
Fields§
§data: T
Any data associated with a point.
Implementations§
Trait Implementations§
source§impl<T: Clone, P: Clone> Clone for PointWithData<T, P>
impl<T: Clone, P: Clone> Clone for PointWithData<T, P>
source§fn clone(&self) -> PointWithData<T, P>
fn clone(&self) -> PointWithData<T, P>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T: Default, P: Default> Default for PointWithData<T, P>
impl<T: Default, P: Default> Default for PointWithData<T, P>
source§fn default() -> PointWithData<T, P>
fn default() -> PointWithData<T, P>
Returns the “default value” for a type. Read more
source§impl<T: Ord, P: Ord> Ord for PointWithData<T, P>
impl<T: Ord, P: Ord> Ord for PointWithData<T, P>
source§fn cmp(&self, other: &PointWithData<T, P>) -> Ordering
fn cmp(&self, other: &PointWithData<T, P>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl<T: PartialEq, P: PartialEq> PartialEq<PointWithData<T, P>> for PointWithData<T, P>
impl<T: PartialEq, P: PartialEq> PartialEq<PointWithData<T, P>> for PointWithData<T, P>
source§fn eq(&self, other: &PointWithData<T, P>) -> bool
fn eq(&self, other: &PointWithData<T, P>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<T: PartialOrd, P: PartialOrd> PartialOrd<PointWithData<T, P>> for PointWithData<T, P>
impl<T: PartialOrd, P: PartialOrd> PartialOrd<PointWithData<T, P>> for PointWithData<T, P>
source§fn partial_cmp(&self, other: &PointWithData<T, P>) -> Option<Ordering>
fn partial_cmp(&self, other: &PointWithData<T, P>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresource§impl<T, P> PointDistance for PointWithData<T, P>where
P: Point,
impl<T, P> PointDistance for PointWithData<T, P>where P: Point,
source§fn distance_2(&self, point: &P) -> <P as Point>::Scalar
fn distance_2(&self, point: &P) -> <P as Point>::Scalar
Returns the squared euclidean distance between an object to a point.
source§fn contains_point(&self, point: &P) -> bool
fn contains_point(&self, point: &P) -> bool
Returns
true
if a point is contained within this object. Read moresource§fn distance_2_if_less_or_equal(
&self,
point: &<Self::Envelope as Envelope>::Point,
max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>
fn distance_2_if_less_or_equal( &self, point: &<Self::Envelope as Envelope>::Point, max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar ) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>
Returns the squared distance to this object, or
None
if the distance
is larger than a given maximum value. Read moresource§impl<T, P> RTreeObject for PointWithData<T, P>where
P: Point,
impl<T, P> RTreeObject for PointWithData<T, P>where P: Point,
impl<T: Copy, P: Copy> Copy for PointWithData<T, P>
impl<T: Eq, P: Eq> Eq for PointWithData<T, P>
impl<T, P> StructuralEq for PointWithData<T, P>
impl<T, P> StructuralPartialEq for PointWithData<T, P>
Auto Trait Implementations§
impl<T, P> RefUnwindSafe for PointWithData<T, P>where P: RefUnwindSafe, T: RefUnwindSafe,
impl<T, P> Send for PointWithData<T, P>where P: Send, T: Send,
impl<T, P> Sync for PointWithData<T, P>where P: Sync, T: Sync,
impl<T, P> Unpin for PointWithData<T, P>where P: Unpin, T: Unpin,
impl<T, P> UnwindSafe for PointWithData<T, P>where P: UnwindSafe, T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more