Struct Point

source

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

Fields§

§array: [T; N]

Implementations§

source §

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

source

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

source

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

§Panics

Panics if any of the inputs are NaN.

source

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

source

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

source

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

source §

impl<T: PolygonScalar> Point<T>

source

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

source

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());

source

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

source

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

source

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

source

pub fn all_colinear(pts: &[Point<T>]) -> bool

source

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

Docs?

source

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

source §

impl<T> Point<T, 1>

source

pub fn x_coord(&self) -> &T

source §

impl<T> Point<T, 2>

source

pub fn x_coord(&self) -> &T

source

pub fn y_coord(&self) -> &T

source §

impl<T> Point<T, 3>

source

pub fn x_coord(&self) -> &T

source

pub fn y_coord(&self) -> &T

source

pub fn z_coord(&self) -> &T

Methods from Deref<Target = [T; N]>§

source

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

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

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

§Examples

#![feature(ascii_char)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

source

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

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

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

§Safety

Every byte in the array must be in 0..=127, or else this is UB.

1.57.0 · source

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

Returns a slice containing the entire array. Equivalent to &s[..].

1.77.0 · source

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

Borrows each element and returns an array of references with the same size as self.

§Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

source

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

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

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

source

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

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

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}