pub struct Point<T = i32, const N: usize = 2>(/* private fields */);
Expand description
A Point
in N-dimensional space.
Please see the module-level documentation for examples.
Implementations§
Source§impl<T, const N: usize> Point<T, N>
impl<T, const N: usize> Point<T, N>
Source§impl<T: Copy, const N: usize> Point<T, N>
impl<T: Copy, const N: usize> Point<T, N>
Sourcepub fn from_vector(v: Vector<T, N>) -> Self
pub fn from_vector(v: Vector<T, N>) -> Self
Sourcepub fn coords(&self) -> [T; N]
pub fn coords(&self) -> [T; N]
Returns Point
coordinates as [T; N]
.
§Example
let p = point!(2, 1, 3);
assert_eq!(p.coords(), [2, 1, 3]);
Sourcepub fn coords_mut(&mut self) -> &mut [T; N]
pub fn coords_mut(&mut self) -> &mut [T; N]
Returns Point
coordinates as a mutable slice &mut [T; N]
.
§Example
let mut p = point!(2, 1, 3);
for v in p.coords_mut() {
*v *= 2;
}
assert_eq!(p.coords(), [4, 2, 6]);
Source§impl<T: Num, const N: usize> Point<T, N>
impl<T: Num, const N: usize> Point<T, N>
Sourcepub fn offset<P, const M: usize>(&mut self, offsets: P)
pub fn offset<P, const M: usize>(&mut self, offsets: P)
Offsets a Point
by shifting coordinates by given amount.
§Examples
let mut p = point!(2, 3, 1);
p.offset([2, -4]);
assert_eq!(p.coords(), [4, -1, 1]);
Sourcepub fn offset_y(&mut self, offset: T)
pub fn offset_y(&mut self, offset: T)
Offsets the y-coordinate
of the point by a given amount.
§Panics
If Vector
has less than 2 dimensions.
Sourcepub fn offset_z(&mut self, offset: T)
pub fn offset_z(&mut self, offset: T)
Offsets the z-coordinate
of the point by a given amount.
§Panics
If Vector
has less than 3 dimensions.
Source§impl<T: Num + Float, const N: usize> Point<T, N>
impl<T: Num + Float, const N: usize> Point<T, N>
Sourcepub fn dist<P>(&self, p: P) -> T
pub fn dist<P>(&self, p: P) -> T
Returns the Euclidean distance between two Point
s.
§Example
let p1 = point!(1.0, 0.0, 0.0);
let p2 = point!(0.0, 1.0, 0.0);
let dist = p1.dist(p2);
let abs_difference: f64 = (dist - std::f64::consts::SQRT_2).abs();
assert!(abs_difference <= 1e-4);
Source§impl<T, const N: usize> Point<T, N>
impl<T, const N: usize> Point<T, N>
Sourcepub fn as_<U>(&self) -> Point<U, N>where
U: 'static + Copy,
T: AsPrimitive<U>,
pub fn as_<U>(&self) -> Point<U, N>where
U: 'static + Copy,
T: AsPrimitive<U>,
Converts Point < T, N > to Point < U, N >.
Methods from Deref<Target = [T; N]>§
1.57.0 · Sourcepub fn as_slice(&self) -> &[T]
pub fn as_slice(&self) -> &[T]
Returns a slice containing the entire array. Equivalent to &s[..]
.
1.57.0 · Sourcepub fn as_mut_slice(&mut self) -> &mut [T]
pub fn as_mut_slice(&mut self) -> &mut [T]
Returns a mutable slice containing the entire array. Equivalent to
&mut s[..]
.
1.77.0 · Sourcepub fn each_ref(&self) -> [&T; N]
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);
1.77.0 · Sourcepub fn each_mut(&mut self) -> [&mut T; N]
pub fn each_mut(&mut self) -> [&mut T; N]
Borrows each element mutably and returns an array of mutable references
with the same size as self
.
§Example
let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);
Sourcepub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])
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, &[]);
}
Sourcepub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
🔬This is a nightly-only experimental API. (split_array
)
pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])
split_array
)Divides one mutable 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 mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);
Sourcepub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])
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]);
}
Sourcepub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
🔬This is a nightly-only experimental API. (split_array
)
pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])
split_array
)Divides one mutable 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 mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);
Trait Implementations§
Source§impl<T, U, const N: usize> AddAssign<U> for Point<T, N>
impl<T, U, const N: usize> AddAssign<U> for Point<T, N>
Source§fn add_assign(&mut self, val: U)
fn add_assign(&mut self, val: U)
+=
operation. Read moreSource§impl<T: Num, const N: usize> AddAssign<Vector<T, N>> for Point<T, N>
impl<T: Num, const N: usize> AddAssign<Vector<T, N>> for Point<T, N>
Source§fn add_assign(&mut self, other: Vector<T, N>)
fn add_assign(&mut self, other: Vector<T, N>)
+=
operation. Read moreSource§impl<T: Num, const N: usize> AddAssign for Point<T, N>
impl<T: Num, const N: usize> AddAssign for Point<T, N>
Source§fn add_assign(&mut self, other: Point<T, N>)
fn add_assign(&mut self, other: Point<T, N>)
+=
operation. Read moreSource§impl<'de, T, const N: usize> Deserialize<'de> for Point<T, N>where
T: Serialize + DeserializeOwned,
impl<'de, T, const N: usize> Deserialize<'de> for Point<T, N>where
T: Serialize + DeserializeOwned,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<T, U, const N: usize> DivAssign<U> for Point<T, N>
impl<T, U, const N: usize> DivAssign<U> for Point<T, N>
Source§fn div_assign(&mut self, val: U)
fn div_assign(&mut self, val: U)
/=
operation. Read moreSource§impl<T: Default, const N: usize> FromIterator<T> for Point<T, N>
impl<T: Default, const N: usize> FromIterator<T> for Point<T, N>
Source§fn from_iter<I>(iter: I) -> Selfwhere
I: IntoIterator<Item = T>,
fn from_iter<I>(iter: I) -> Selfwhere
I: IntoIterator<Item = T>,
Source§impl<'a, T, const N: usize> IntoIterator for &'a Point<T, N>
impl<'a, T, const N: usize> IntoIterator for &'a Point<T, N>
Source§impl<'a, T, const N: usize> IntoIterator for &'a mut Point<T, N>
impl<'a, T, const N: usize> IntoIterator for &'a mut Point<T, N>
Source§impl<T, const N: usize> IntoIterator for Point<T, N>
impl<T, const N: usize> IntoIterator for Point<T, N>
Source§impl<T, U, const N: usize> MulAssign<U> for Point<T, N>
impl<T, U, const N: usize> MulAssign<U> for Point<T, N>
Source§fn mul_assign(&mut self, val: U)
fn mul_assign(&mut self, val: U)
*=
operation. Read moreSource§impl<T: Ord, const N: usize> Ord for Point<T, N>
impl<T: Ord, const N: usize> Ord for Point<T, N>
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<T: PartialOrd, const N: usize> PartialOrd for Point<T, N>
impl<T: PartialOrd, const N: usize> PartialOrd for Point<T, N>
Source§impl<T, U, const N: usize> SubAssign<U> for Point<T, N>
impl<T, U, const N: usize> SubAssign<U> for Point<T, N>
Source§fn sub_assign(&mut self, val: U)
fn sub_assign(&mut self, val: U)
-=
operation. Read moreSource§impl<T: Num, const N: usize> SubAssign<Vector<T, N>> for Point<T, N>
impl<T: Num, const N: usize> SubAssign<Vector<T, N>> for Point<T, N>
Source§fn sub_assign(&mut self, other: Vector<T, N>)
fn sub_assign(&mut self, other: Vector<T, N>)
-=
operation. Read moreSource§impl<T: Num, const N: usize> SubAssign for Point<T, N>
impl<T: Num, const N: usize> SubAssign for Point<T, N>
Source§fn sub_assign(&mut self, other: Point<T, N>)
fn sub_assign(&mut self, other: Point<T, N>)
-=
operation. Read moreimpl<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> StructuralPartialEq for Point<T, N>
Auto Trait Implementations§
impl<T, const N: usize> Freeze for Point<T, N>where
T: Freeze,
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§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.