use num::One; use std::hash; use std::fmt; use std::cmp::Ordering; use approx::ApproxEq; #[cfg(feature = "serde-serialize")] use serde; #[cfg(feature = "abomonation-serialize")] use abomonation::Abomonation; use core::{DefaultAllocator, Scalar, VectorN}; use core::iter::{MatrixIter, MatrixIterMut}; use core::dimension::{DimName, DimNameSum, DimNameAdd, U1}; use core::allocator::Allocator; /// A point in a n-dimensional euclidean space. #[repr(C)] #[derive(Debug)] pub struct Point where DefaultAllocator: Allocator { /// The coordinates of this point, i.e., the shift from the origin. pub coords: VectorN } impl hash::Hash for Point where DefaultAllocator: Allocator, >::Buffer: hash::Hash { fn hash(&self, state: &mut H) { self.coords.hash(state) } } impl Copy for Point where DefaultAllocator: Allocator, >::Buffer: Copy { } impl Clone for Point where DefaultAllocator: Allocator, >::Buffer: Clone { #[inline] fn clone(&self) -> Self { Point::from_coordinates(self.coords.clone()) } } #[cfg(feature = "serde-serialize")] impl serde::Serialize for Point where DefaultAllocator: Allocator, >::Buffer: serde::Serialize { fn serialize(&self, serializer: S) -> Result where S: serde::Serializer { self.coords.serialize(serializer) } } #[cfg(feature = "serde-serialize")] impl<'a, N: Scalar, D: DimName> serde::Deserialize<'a> for Point where DefaultAllocator: Allocator, >::Buffer: serde::Deserialize<'a> { fn deserialize(deserializer: Des) -> Result where Des: serde::Deserializer<'a> { let coords = VectorN::::deserialize(deserializer)?; Ok(Point::from_coordinates(coords)) } } #[cfg(feature = "abomonation-serialize")] impl Abomonation for PointBase where N: Scalar, D: DimName, ColumnVector: Abomonation, DefaultAllocator: Allocator { unsafe fn entomb(&self, writer: &mut Vec) { self.coords.entomb(writer) } unsafe fn embalm(&mut self) { self.coords.embalm() } unsafe fn exhume<'a, 'b>(&'a mut self, bytes: &'b mut [u8]) -> Option<&'b mut [u8]> { self.coords.exhume(bytes) } } impl Point where DefaultAllocator: Allocator { /// Clones this point into one that owns its data. #[inline] pub fn clone(&self) -> Point { Point::from_coordinates(self.coords.clone_owned()) } /// Converts this point into a vector in homogeneous coordinates, i.e., appends a `1` at the /// end of it. #[inline] pub fn to_homogeneous(&self) -> VectorN> where N: One, D: DimNameAdd, DefaultAllocator: Allocator> { let mut res = unsafe { VectorN::<_, DimNameSum>::new_uninitialized() }; res.fixed_slice_mut::(0, 0).copy_from(&self.coords); res[(D::dim(), 0)] = N::one(); res } /// Creates a new point with the given coordinates. #[inline] pub fn from_coordinates(coords: VectorN) -> Point { Point { coords: coords } } /// The dimension of this point. #[inline] pub fn len(&self) -> usize { self.coords.len() } /// The stride of this point. This is the number of buffer element separating each component of /// this point. #[inline] pub fn stride(&self) -> usize { self.coords.strides().0 } /// Iterates through this point coordinates. #[inline] pub fn iter(&self) -> MatrixIter>::Buffer> { self.coords.iter() } /// Gets a reference to i-th element of this point without bound-checking. #[inline] pub unsafe fn get_unchecked(&self, i: usize) -> &N { self.coords.vget_unchecked(i) } /// Mutably iterates through this point coordinates. #[inline] pub fn iter_mut(&mut self) -> MatrixIterMut>::Buffer> { self.coords.iter_mut() } /// Gets a mutable reference to i-th element of this point without bound-checking. #[inline] pub unsafe fn get_unchecked_mut(&mut self, i: usize) -> &mut N { self.coords.vget_unchecked_mut(i) } /// Swaps two entries without bound-checking. #[inline] pub unsafe fn swap_unchecked(&mut self, i1: usize, i2: usize) { self.coords.swap_unchecked((i1, 0), (i2, 0)) } } impl ApproxEq for Point where DefaultAllocator: Allocator, N::Epsilon: Copy { type Epsilon = N::Epsilon; #[inline] fn default_epsilon() -> Self::Epsilon { N::default_epsilon() } #[inline] fn default_max_relative() -> Self::Epsilon { N::default_max_relative() } #[inline] fn default_max_ulps() -> u32 { N::default_max_ulps() } #[inline] fn relative_eq(&self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon) -> bool { self.coords.relative_eq(&other.coords, epsilon, max_relative) } #[inline] fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool { self.coords.ulps_eq(&other.coords, epsilon, max_ulps) } } impl Eq for Point where DefaultAllocator: Allocator { } impl PartialEq for Point where DefaultAllocator: Allocator { #[inline] fn eq(&self, right: &Self) -> bool { self.coords == right.coords } } impl PartialOrd for Point where DefaultAllocator: Allocator { #[inline] fn partial_cmp(&self, other: &Self) -> Option { self.coords.partial_cmp(&other.coords) } #[inline] fn lt(&self, right: &Self) -> bool { self.coords.lt(&right.coords) } #[inline] fn le(&self, right: &Self) -> bool { self.coords.le(&right.coords) } #[inline] fn gt(&self, right: &Self) -> bool { self.coords.gt(&right.coords) } #[inline] fn ge(&self, right: &Self) -> bool { self.coords.ge(&right.coords) } } /* * * Display * */ impl fmt::Display for Point where DefaultAllocator: Allocator { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { try!(write!(f, "{{")); let mut it = self.coords.iter(); try!(write!(f, "{}", *it.next().unwrap())); for comp in it { try!(write!(f, ", {}", *comp)); } write!(f, "}}") } }