Struct rgeometry::data::Point

source · [−]

#[repr(transparent)]
pub struct Point<T, const N: usize = 2_usize> {
    pub array: [T; N],
}

Fields

array: [T; N]

Implementations

impl<T, const N: usize> Point<T, N>

pub const fn new(array: [T; N]) -> Point<T, N>

pub fn new_nn(array: [T; N]) -> Point<NotNan<T>, N> where
T: Float,

Panics

Panics if any of the inputs are NaN.

pub fn as_vec(&self) -> &Vector<T, N>

pub fn squared_euclidean_distance<F>(&self, rhs: &Point<T, N>) -> F where
T: Clone + Into<F>,
F: NumOps + Clone + Sum,

pub fn zero() -> Self where
T: Sum,

pub fn map<U, F>(&self, f: F) -> Point<U, N> where
T: Clone,
F: Fn(T) -> U,

pub fn cast<U>(&self) -> Point<U, N> where
T: Clone + Into<U>,

pub fn to_float(&self) -> Point<OrderedFloat<f64>, N> where
T: Clone + Into<f64>,

impl<T: PolygonScalar> Point<T, 2>

pub fn cmp_distance_to(&self, p: &Point<T, 2>, q: &Point<T, 2>) -> Ordering

pub fn orient(
    p1: &Point<T, 2>,
    p2: &Point<T, 2>,
    p3: &Point<T, 2>
) -> Orientation

Determine the direction you have to turn if you walk from p1 to p2 to p3.

For fixed-precision types (i8,i16,i32,i64,etc), this function is guaranteed to work for any input and never cause any arithmetic overflows.

Examples

let p1 = Point::new([ 0, 0 ]);
let p2 = Point::new([ 0, 1 ]); // One unit above p1.
// (0,0) -> (0,1) -> (0,2) == Orientation::CoLinear
assert!(Point::orient(&p1, &p2, &Point::new([ 0, 2 ])).is_colinear());
// (0,0) -> (0,1) -> (-1,2) == Orientation::CounterClockWise
assert!(Point::orient(&p1, &p2, &Point::new([ -1, 2 ])).is_ccw());
// (0,0) -> (0,1) -> (1,2) == Orientation::ClockWise
assert!(Point::orient(&p1, &p2, &Point::new([ 1, 2 ])).is_cw());

pub fn orient_along_direction(
    p1: &Point<T, 2>,
    direction: Direction<'_, T, 2>,
    p2: &Point<T, 2>
) -> Orientation

pub fn orient_along_vector(
    p1: &Point<T, 2>,
    vector: &Vector<T, 2>,
    p2: &Point<T, 2>
) -> Orientation

pub fn orient_along_perp_vector(
    p1: &Point<T, 2>,
    vector: &Vector<T, 2>,
    p2: &Point<T, 2>
) -> Orientation

pub fn ccw_cmp_around(&self, p: &Point<T, 2>, q: &Point<T, 2>) -> Ordering

Docs?

pub fn ccw_cmp_around_with(
    &self,
    z: &Vector<T, 2>,
    p: &Point<T, 2>,
    q: &Point<T, 2>
) -> Ordering

impl<T> Point<T, 1>

pub fn x_coord(&self) -> &T

impl<T> Point<T, 2>

pub fn x_coord(&self) -> &T

pub fn y_coord(&self) -> &T

impl<T> Point<T, 3>

pub fn x_coord(&self) -> &T

pub fn y_coord(&self) -> &T

pub fn z_coord(&self) -> &T

Trait Implementations

impl<T, const N: usize> Add<&'_ Vector<T, N>> for Point<T, N> where
for<'a> &'a T: Add<&'a T, Output = T>,

type Output = Point<T, N>

The resulting type after applying the + operator.

fn add(self: Point<T, N>, other: &Vector<T, N>) -> Self::Output

Performs the + operation. Read more

impl<'a, 'b, T, const N: usize> Add<&'a Vector<T, N>> for &'b Point<T, N> where
for<'c> &'c T: Add<&'c T, Output = T>,

type Output = Point<T, N>

The resulting type after applying the + operator.

fn add(self: &'b Point<T, N>, other: &'a Vector<T, N>) -> Self::Output

Performs the + operation. Read more

impl<T, const N: usize> Add<Vector<T, N>> for Point<T, N> where
for<'a> &'a T: Add<&'a T, Output = T>,

type Output = Point<T, N>

The resulting type after applying the + operator.

fn add(self: Point<T, N>, other: Vector<T, N>) -> Self::Output

Performs the + operation. Read more

impl<T, const N: usize> AddAssign<&'_ Vector<T, N>> for Point<T, N> where
T: NumOps + Clone + AddAssign,

fn add_assign(&mut self, other: &Vector<T, N>)

Performs the += operation. Read more

impl<T, const N: usize> AddAssign<Vector<T, N>> for Point<T, N> where
T: NumOps + Clone + AddAssign,

fn add_assign(&mut self, other: Vector<T, N>)

Performs the += operation. Read more

impl<T: Clone, const N: usize> Clone for Point<T, N>

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug, const N: usize> Debug for Point<T, N>

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

Formats the value using the given formatter. Read more

impl<T, const N: usize> Deref for Point<T, N>

type Target = [T; N]

The resulting type after dereferencing.

fn deref(&self) -> &[T; N]

Dereferences the value.

impl<T, const N: usize> Distribution<Point<T, N>> for Standard where
Standard: Distribution<T>,

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Point<T, N>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
F: Fn(T) -> S,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

impl<'a, const N: usize> From<&'a Point<Ratio<BigInt>, N>> for Point<f64, N>

fn from(point: &Point<BigRational, N>) -> Point<f64, N>

Converts to this type from the input type.

impl<'a, T, const N: usize> From<&'a Point<T, N>> for &'a Vector<T, N>

fn from(point: &Point<T, N>) -> &Vector<T, N>

Converts to this type from the input type.

impl<'a, T, const N: usize> From<&'a Point<T, N>> for VectorView<'a, T, N>

fn from(point: &Point<T, N>) -> VectorView<'_, T, N>

Converts to this type from the input type.

impl<'a, const N: usize> From<&'a Point<f64, N>> for Point<BigRational, N>

fn from(point: &Point<f64, N>) -> Point<BigRational, N>

Converts to this type from the input type.

impl<T> From<(T, T)> for Point<T, 2>

fn from(point: (T, T)) -> Point<T, 2>

Converts to this type from the input type.

impl<const N: usize> From<Point<Ratio<BigInt>, N>> for Point<f64, N>

fn from(point: Point<BigRational, N>) -> Point<f64, N>

Converts to this type from the input type.

impl<T, const N: usize> From<Point<T, N>> for Vector<T, N>

fn from(point: Point<T, N>) -> Vector<T, N>

Converts to this type from the input type.

impl<const N: usize> From<Point<f64, N>> for Point<BigRational, N>

fn from(point: Point<f64, N>) -> Point<BigRational, N>

Converts to this type from the input type.

impl From<Point<i64, 2_usize>> for Point<BigInt, 2>

fn from(point: Point<i64, 2>) -> Point<BigInt, 2>

Converts to this type from the input type.

impl<T, const N: usize> From<Vector<T, N>> for Point<T, N>

fn from(vector: Vector<T, N>) -> Point<T, N>

Converts to this type from the input type.

impl<T, const N: usize> Index<usize> for Point<T, N>

type Output = T

The returned type after indexing.

fn index(&self, key: usize) -> &T

Performs the indexing (container[index]) operation. Read more

impl<'a, 'b, T, const N: usize> Mul<&'b Point<T, N>> for &'a Transform<T, N> where
T: TransformScalar,

type Output = Point<T, N>

The resulting type after applying the * operator.

fn mul(self, other: &Point<T, N>) -> Point<T, N>

Performs the * operation. Read more

impl<T, const N: usize> Mul<Point<T, N>> for Transform<T, N> where
T: TransformScalar,

type Output = Point<T, N>

The resulting type after applying the * operator.

fn mul(self, other: Point<T, N>) -> Point<T, N>

Performs the * operation. Read more

impl<'a, T, const N: usize> Mul<Point<T, N>> for &'a Transform<T, N> where
T: TransformScalar,

type Output = Point<T, N>

The resulting type after applying the * operator.

fn mul(self, other: Point<T, N>) -> Point<T, N>

Performs the * operation. Read more

impl<T: Ord, const N: usize> Ord for Point<T, N>

fn cmp(&self, other: &Point<T, N>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

impl<T: PartialEq, const N: usize> PartialEq<Point<T, N>> for Point<T, N>

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

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

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

This method tests for !=.

impl<T: PartialOrd, const N: usize> PartialOrd<Point<T, N>> for Point<T, N>

fn partial_cmp(&self, other: &Point<T, N>) -> Option<Ordering>

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

1.0.0 · source

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

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

1.0.0 · source

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 more

1.0.0 · source

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

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

1.0.0 · source

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

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

impl<'a, 'b, T, const N: usize> Sub<&'a Point<T, N>> for &'b Point<T, N> where
T: Sub<T, Output = T> + Clone,

type Output = Vector<T, N>

The resulting type after applying the - operator.

fn sub(self: &'b Point<T, N>, other: &'a Point<T, N>) -> Self::Output

Performs the - operation. Read more

impl<T, const N: usize> Sub<Point<T, N>> for Point<T, N> where
T: Sub<T, Output = T> + Clone,

type Output = Vector<T, N>

The resulting type after applying the - operator.

fn sub(self: Point<T, N>, other: Point<T, N>) -> Self::Output

Performs the - operation. Read more

impl<'a, const N: usize> TryFrom<Point<f64, N>> for Point<NotNan<f64>, N>

type Error = FloatIsNan

The type returned in the event of a conversion error.

fn try_from(point: Point<f64, N>) -> Result<Point<NotNan<f64>, N>, FloatIsNan>

Performs the conversion.

impl<T: Copy, const N: usize> Copy for Point<T, N>

impl<T: Eq, const N: usize> Eq for Point<T, N>

impl<T, const N: usize> StructuralEq for Point<T, N>

impl<T, const N: usize> StructuralPartialEq for Point<T, N>

Auto Trait Implementations

impl<T, const N: usize> RefUnwindSafe for Point<T, N> where
T: RefUnwindSafe,

impl<T, const N: usize> Send for Point<T, N> where
T: Send,

impl<T, const N: usize> Sync for Point<T, N> where
T: Sync,

impl<T, const N: usize> Unpin for Point<T, N> where
T: Unpin,

impl<T, const N: usize> UnwindSafe for Point<T, N> where
T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V