Struct rstar::primitives::PointWithData

pub struct PointWithData<T, P> {
    pub data: T,
    // some fields omitted
}

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>

pub fn new(data: T, point: P) -> Self

Creates a new PointWithData with the provided data.

pub fn position(&self) -> &P

Returns this point’s position.

Trait Implementations

impl<T: Clone, P: Clone> Clone for PointWithData<T, P>

fn clone(&self) -> PointWithData<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, P: Copy> Copy for PointWithData<T, P>

impl<T: Debug, P: Debug> Debug for PointWithData<T, P>

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

Formats the value using the given formatter.

impl<T: Default, P: Default> Default for PointWithData<T, P>

fn default() -> PointWithData<T, P>

Returns the “default value” for a type.

impl<T: Eq, P: Eq> Eq for PointWithData<T, P>

impl<T: Hash, P: Hash> Hash for PointWithData<T, P>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord, P: Ord> Ord for PointWithData<T, P>

fn cmp(&self, other: &PointWithData<T, P>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq, P: PartialEq> PartialEq<PointWithData<T, P>> for PointWithData<T, P>

fn eq(&self, other: &PointWithData<T, P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PointWithData<T, P>) -> bool

This method tests for !=.

impl<T: PartialOrd, P: PartialOrd> PartialOrd<PointWithData<T, P>> for PointWithData<T, P>

fn partial_cmp(&self, other: &PointWithData<T, P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, P> PointDistance for PointWithData<T, P> where
    P: Point, 

fn distance_2(&self, point: &P) -> <P as Point>::Scalar

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &P) -> bool

Returns true if a point is contained within this object.

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.

impl<T, P> RTreeObject for PointWithData<T, P> where
    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.

fn envelope(&self) -> Self::Envelope

Returns the object’s envelope.

impl<T, P> StructuralEq for PointWithData<T, P>

impl<T, P> StructuralPartialEq for PointWithData<T, P>