Point

Struct Point 

Source
pub struct Point<T: SpatialScalar> { /* private fields */ }
Expand description

Generic point structure for spatial algorithms

Implementations§

Source§

impl<T: SpatialScalar> Point<T>

Source

pub fn new(coords: Vec<T>) -> Self

Create a new point from coordinates

Source

pub fn zeros(dim: usize) -> Self

Create a point with the given dimension filled with zeros

Source

pub fn new_2d(x: T, y: T) -> Self

Create a 2D point

Source

pub fn new_3d(x: T, y: T, z: T) -> Self

Create a 3D point

Source

pub fn coords(&self) -> &[T]

Get the coordinates as a slice

Source

pub fn coords_mut(&mut self) -> &mut [T]

Get mutable access to coordinates

Source

pub fn add(&self, other: &Point<T>) -> Option<Point<T>>

Add another point (vector addition)

Source

pub fn subtract(&self, other: &Point<T>) -> Option<Point<T>>

Subtract another point (vector subtraction)

Source

pub fn scale(&self, factor: T) -> Point<T>

Scale the point by a scalar

Source

pub fn dot(&self, other: &Point<T>) -> Option<T>

Calculate the dot product with another point

Source

pub fn magnitude(&self) -> T

Calculate the magnitude (length) of the point as a vector

Source

pub fn normalize(&self) -> Point<T>

Normalize the point to unit length

Trait Implementations§

Source§

impl<T: Clone + SpatialScalar> Clone for Point<T>

Source§

fn clone(&self) -> Point<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + SpatialScalar> Debug for Point<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq + SpatialScalar> PartialEq for Point<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: SpatialScalar> SpatialPoint<T> for Point<T>

Source§

fn dimension(&self) -> usize

Get the dimension of the point
Source§

fn coordinate(&self, index: usize) -> Option<T>

Get the coordinate at the given index
Source§

fn as_slice(&self) -> Option<&[T]>

Get all coordinates as a slice if possible (for efficiency)
Source§

fn from_coords(coords: &[T]) -> Self

Create a point from coordinates
Source§

fn squared_distance_to(&self, other: &Self) -> T

Calculate squared Euclidean distance to another point
Source§

fn distance_to(&self, other: &Self) -> T

Calculate Euclidean distance to another point
Source§

fn manhattan_distance_to(&self, other: &Self) -> T

Calculate Manhattan distance to another point
Source§

impl<T: SpatialScalar> StructuralPartialEq for Point<T>

Auto Trait Implementations§

§

impl<T> Freeze for Point<T>

§

impl<T> RefUnwindSafe for Point<T>
where T: RefUnwindSafe,

§

impl<T> Send for Point<T>

§

impl<T> Sync for Point<T>

§

impl<T> Unpin for Point<T>
where T: Unpin,

§

impl<T> UnwindSafe for Point<T>
where T: 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,