[−][src]Struct rstar::primitives::PointWithData
A point with some associated data that can be inserted into an r-tree.
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
impl<T, P> PointWithData<T, P>
[src]
pub fn new(data: T, point: P) -> Self
[src]
Creates a new PointWithData
with the provided data.
pub fn position(&self) -> &P
[src]
Returns this point's position.
Trait Implementations
impl<T: Clone, P: Clone> Clone for PointWithData<T, P>
[src]
fn clone(&self) -> PointWithData<T, P>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Copy, P: Copy> Copy for PointWithData<T, P>
[src]
impl<T: Debug, P: Debug> Debug for PointWithData<T, P>
[src]
impl<T: Default, P: Default> Default for PointWithData<T, P>
[src]
fn default() -> PointWithData<T, P>
[src]
impl<T: Eq, P: Eq> Eq for PointWithData<T, P>
[src]
impl<T: Hash, P: Hash> Hash for PointWithData<T, P>
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: Ord, P: Ord> Ord for PointWithData<T, P>
[src]
fn cmp(&self, other: &PointWithData<T, P>) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T: PartialEq, P: PartialEq> PartialEq<PointWithData<T, P>> for PointWithData<T, P>
[src]
fn eq(&self, other: &PointWithData<T, P>) -> bool
[src]
fn ne(&self, other: &PointWithData<T, P>) -> bool
[src]
impl<T: PartialOrd, P: PartialOrd> PartialOrd<PointWithData<T, P>> for PointWithData<T, P>
[src]
fn partial_cmp(&self, other: &PointWithData<T, P>) -> Option<Ordering>
[src]
fn lt(&self, other: &PointWithData<T, P>) -> bool
[src]
fn le(&self, other: &PointWithData<T, P>) -> bool
[src]
fn gt(&self, other: &PointWithData<T, P>) -> bool
[src]
fn ge(&self, other: &PointWithData<T, P>) -> bool
[src]
impl<T, P> PointDistance for PointWithData<T, P> where
P: Point,
[src]
P: Point,
fn distance_2(&self, point: &P) -> <P as Point>::Scalar
[src]
fn contains_point(&self, point: &P) -> bool
[src]
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>
[src]
&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>
impl<T, P> RTreeObject for PointWithData<T, P> where
P: Point,
[src]
P: Point,
type Envelope = AABB<P>
The object's envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality. Read more
fn envelope(&self) -> Self::Envelope
[src]
impl<T, P> StructuralEq for PointWithData<T, P>
[src]
impl<T, P> StructuralPartialEq for PointWithData<T, P>
[src]
Auto Trait Implementations
impl<T, P> RefUnwindSafe for PointWithData<T, P> where
P: RefUnwindSafe,
T: RefUnwindSafe,
P: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, P> Send for PointWithData<T, P> where
P: Send,
T: Send,
P: Send,
T: Send,
impl<T, P> Sync for PointWithData<T, P> where
P: Sync,
T: Sync,
P: Sync,
T: Sync,
impl<T, P> Unpin for PointWithData<T, P> where
P: Unpin,
T: Unpin,
P: Unpin,
T: Unpin,
impl<T, P> UnwindSafe for PointWithData<T, P> where
P: UnwindSafe,
T: UnwindSafe,
P: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,