      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331

    use approx::{AbsDiffEq, RelativeEq, UlpsEq};
    use num::One;
    use std::cmp::Ordering;
    use std::fmt;
    use std::hash;
    #[cfg(feature = "abomonation-serialize")]
    use std::io::{Result as IOResult, Write};

    #[cfg(feature = "serde-serialize")]
    use serde::{Deserialize, Deserializer, Serialize, Serializer};

    #[cfg(feature = "abomonation-serialize")]
    use abomonation::Abomonation;

    use crate::base::allocator::Allocator;
    use crate::base::dimension::{DimName, DimNameAdd, DimNameSum, U1};
    use crate::base::iter::{MatrixIter, MatrixIterMut};
    use crate::base::{DefaultAllocator, Scalar, VectorN};

    /// A point in a n-dimensional euclidean space.
    #[repr(C)]
    #[derive(Debug, Clone)]
    pub struct Point<N: Scalar, D: DimName>
    where DefaultAllocator: Allocator<N, D>
    {
        /// The coordinates of this point, i.e., the shift from the origin.
        pub coords: VectorN<N, D>,
    }

    impl<N: Scalar + hash::Hash, D: DimName + hash::Hash> hash::Hash for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        <DefaultAllocator as Allocator<N, D>>::Buffer: hash::Hash,
    {
        fn hash<H: hash::Hasher>(&self, state: &mut H) {
            self.coords.hash(state)
        }
    }

    impl<N: Scalar, D: DimName> Copy for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        <DefaultAllocator as Allocator<N, D>>::Buffer: Copy,
    {
    }

    #[cfg(feature = "serde-serialize")]
    impl<N: Scalar, D: DimName> Serialize for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        <DefaultAllocator as Allocator<N, D>>::Buffer: Serialize,
    {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where S: Serializer {
            self.coords.serialize(serializer)
        }
    }

    #[cfg(feature = "serde-serialize")]
    impl<'a, N: Scalar, D: DimName> Deserialize<'a> for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        <DefaultAllocator as Allocator<N, D>>::Buffer: Deserialize<'a>,
    {
        fn deserialize<Des>(deserializer: Des) -> Result<Self, Des::Error>
        where Des: Deserializer<'a> {
            let coords = VectorN::<N, D>::deserialize(deserializer)?;

            Ok(Self::from(coords))
        }
    }

    #[cfg(feature = "abomonation-serialize")]
    impl<N, D> Abomonation for Point<N, D>
    where
        N: Scalar,
        D: DimName,
        VectorN<N, D>: Abomonation,
        DefaultAllocator: Allocator<N, D>,
    {
        unsafe fn entomb<W: Write>(&self, writer: &mut W) -> IOResult<()> {
            self.coords.entomb(writer)
        }

        fn extent(&self) -> usize {
            self.coords.extent()
        }

        unsafe fn exhume<'a, 'b>(&'a mut self, bytes: &'b mut [u8]) -> Option<&'b mut [u8]> {
            self.coords.exhume(bytes)
        }
    }

    impl<N: Scalar, D: DimName> Point<N, D>
    where DefaultAllocator: Allocator<N, D>
    {
        /// Converts this point into a vector in homogeneous coordinates, i.e., appends a `1` at the
        /// end of it.
        ///
        /// This is the same as `.into()`.
        ///
        /// # Example
        /// ```
        /// # use nalgebra::{Point2, Point3, Vector3, Vector4};
        /// let p = Point2::new(10.0, 20.0);
        /// assert_eq!(p.to_homogeneous(), Vector3::new(10.0, 20.0, 1.0));
        ///
        /// // This works in any dimension.
        /// let p = Point3::new(10.0, 20.0, 30.0);
        /// assert_eq!(p.to_homogeneous(), Vector4::new(10.0, 20.0, 30.0, 1.0));
        /// ```
        #[inline]
        pub fn to_homogeneous(&self) -> VectorN<N, DimNameSum<D, U1>>
        where
            N: One,
            D: DimNameAdd<U1>,
            DefaultAllocator: Allocator<N, DimNameSum<D, U1>>,
        {
            let mut res = unsafe { VectorN::<_, DimNameSum<D, U1>>::new_uninitialized() };
            res.fixed_slice_mut::<D, U1>(0, 0).copy_from(&self.coords);
            res[(D::dim(), 0)] = N::one();

            res
        }

        /// Creates a new point with the given coordinates.
        #[deprecated(note = "Use Point::from(vector) instead.")]
        #[inline]
        pub fn from_coordinates(coords: VectorN<N, D>) -> Self {
            Self { coords: coords }
        }

        /// The dimension of this point.
        ///
        /// # Example
        /// ```
        /// # use nalgebra::{Point2, Point3};
        /// let p = Point2::new(1.0, 2.0);
        /// assert_eq!(p.len(), 2);
        ///
        /// // This works in any dimension.
        /// let p = Point3::new(10.0, 20.0, 30.0);
        /// assert_eq!(p.len(), 3);
        /// ```
        #[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]
        #[deprecated(note = "This methods is no longer significant and will always return 1.")]
        pub fn stride(&self) -> usize {
            self.coords.strides().0
        }

        /// Iterates through this point coordinates.
        ///
        /// # Example
        /// ```
        /// # use nalgebra::Point3;
        /// let p = Point3::new(1.0, 2.0, 3.0);
        /// let mut it = p.iter().cloned();
        ///
        /// assert_eq!(it.next(), Some(1.0));
        /// assert_eq!(it.next(), Some(2.0));
        /// assert_eq!(it.next(), Some(3.0));
        /// assert_eq!(it.next(), None);
        #[inline]
        pub fn iter(&self) -> MatrixIter<N, D, U1, <DefaultAllocator as Allocator<N, D>>::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.
        ///
        /// # Example
        /// ```
        /// # use nalgebra::Point3;
        /// let mut p = Point3::new(1.0, 2.0, 3.0);
        ///
        /// for e in p.iter_mut() {
        ///     *e *= 10.0;
        /// }
        ///
        /// assert_eq!(p, Point3::new(10.0, 20.0, 30.0));
        #[inline]
        pub fn iter_mut(
            &mut self,
        ) -> MatrixIterMut<N, D, U1, <DefaultAllocator as Allocator<N, D>>::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<N: Scalar + AbsDiffEq, D: DimName> AbsDiffEq for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        N::Epsilon: Copy,
    {
        type Epsilon = N::Epsilon;

        #[inline]
        fn default_epsilon() -> Self::Epsilon {
            N::default_epsilon()
        }

        #[inline]
        fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool {
            self.coords.abs_diff_eq(&other.coords, epsilon)
        }
    }

    impl<N: Scalar + RelativeEq, D: DimName> RelativeEq for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        N::Epsilon: Copy,
    {
        #[inline]
        fn default_max_relative() -> Self::Epsilon {
            N::default_max_relative()
        }

        #[inline]
        fn relative_eq(
            &self,
            other: &Self,
            epsilon: Self::Epsilon,
            max_relative: Self::Epsilon,
        ) -> bool
        {
            self.coords
                .relative_eq(&other.coords, epsilon, max_relative)
        }
    }

    impl<N: Scalar + UlpsEq, D: DimName> UlpsEq for Point<N, D>
    where
        DefaultAllocator: Allocator<N, D>,
        N::Epsilon: Copy,
    {
        #[inline]
        fn default_max_ulps() -> u32 {
            N::default_max_ulps()
        }

        #[inline]
        fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool {
            self.coords.ulps_eq(&other.coords, epsilon, max_ulps)
        }
    }

    impl<N: Scalar + Eq, D: DimName> Eq for Point<N, D> where DefaultAllocator: Allocator<N, D> {}

    impl<N: Scalar, D: DimName> PartialEq for Point<N, D>
    where DefaultAllocator: Allocator<N, D>
    {
        #[inline]
        fn eq(&self, right: &Self) -> bool {
            self.coords == right.coords
        }
    }

    impl<N: Scalar + PartialOrd, D: DimName> PartialOrd for Point<N, D>
    where DefaultAllocator: Allocator<N, D>
    {
        #[inline]
        fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
            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<N: Scalar + fmt::Display, D: DimName> fmt::Display for Point<N, D>
    where DefaultAllocator: Allocator<N, D>
    {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "{{")?;

            let mut it = self.coords.iter();

            write!(f, "{}", *it.next().unwrap())?;

            for comp in it {
                write!(f, ", {}", *comp)?;
            }

            write!(f, "}}")
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)