groan_rs 0.11.3

// Released under MIT License.
// Copyright (c) 2023-2025 Ladislav Bartos

//! Implementation of methods for three-dimensional vector.

use std::{
    fmt::Display,
    ops::{Add, Deref, DerefMut, Div, Mul, Sub},
};

use crate::structures::{dimension::Dimension, simbox::SimBox};
use nalgebra::{base::Vector3, Matrix3};

/// Describes length and orientation of a vector in space or a position of a point in space.
/// Since v0.7.0 implemented using `nalgebra`'s Vector3
#[derive(Debug, PartialEq, Clone)]
#[repr(transparent)]
pub struct Vector3D(pub(crate) Vector3<f32>);

impl Display for Vector3D {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "[{}, {}, {}]", self.x, self.y, self.z)
    }
}

/// Function replicating the behavior of Python '%'.
#[inline]
fn floor_mod(x: f32, y: f32) -> f32 {
    (x % y + y) % y
}

/// Reciprocal of square root of 2, i.e. 1/sqrt(2).
const REC_SQRT2: f32 = std::f32::consts::FRAC_1_SQRT_2;
/// Reciprocal of square root of 3, i.e. 1/sqrt(3).
const REC_SQRT3: f32 = 0.577_350_3_f32;

impl From<[f32; 3]> for Vector3D {
    #[inline(always)]
    fn from(arr: [f32; 3]) -> Self {
        Vector3D(Vector3::new(arr[0], arr[1], arr[2]))
    }
}

impl From<[f64; 3]> for Vector3D {
    #[inline(always)]
    fn from(arr: [f64; 3]) -> Self {
        Vector3D(Vector3::new(arr[0] as f32, arr[1] as f32, arr[2] as f32))
    }
}

impl From<Dimension> for Vector3D {
    /// Get unit vector oriented along the specified dimension(s).
    /// If `dim` is `Dimension::None`, returns a null vector.
    #[inline]
    fn from(dim: Dimension) -> Self {
        match dim {
            Dimension::None => [0.0, 0.0, 0.0].into(),
            Dimension::X => [1.0, 0.0, 0.0].into(),
            Dimension::Y => [0.0, 1.0, 0.0].into(),
            Dimension::Z => [0.0, 0.0, 1.0].into(),
            Dimension::XY => [REC_SQRT2, REC_SQRT2, 0.0].into(),
            Dimension::XZ => [REC_SQRT2, 0.0, REC_SQRT2].into(),
            Dimension::YZ => [0.0, REC_SQRT2, REC_SQRT2].into(),
            Dimension::XYZ => [REC_SQRT3, REC_SQRT3, REC_SQRT3].into(),
        }
    }
}

impl From<Vector3<f32>> for Vector3D {
    #[inline(always)]
    fn from(vec: Vector3<f32>) -> Self {
        Vector3D(vec)
    }
}

impl Deref for Vector3D {
    type Target = Vector3<f32>;

    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Vector3D {
    #[inline(always)]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

// Addition for owned Vector3D
impl Add for Vector3D {
    type Output = Self;

    fn add(self, other: Self) -> Self::Output {
        Vector3D(self.0 + other.0)
    }
}

// Addition for &Vector3D
impl Add<&Vector3D> for Vector3D {
    type Output = Self;

    fn add(self, other: &Vector3D) -> Self::Output {
        Vector3D(self.0 + other.0)
    }
}

impl Add<Vector3D> for &Vector3D {
    type Output = Vector3D;

    fn add(self, other: Vector3D) -> Self::Output {
        Vector3D(self.0 + other.0)
    }
}

impl Add<&Vector3D> for &Vector3D {
    type Output = Vector3D;

    fn add(self, other: &Vector3D) -> Self::Output {
        Vector3D(self.0 + other.0)
    }
}

// Subtraction for owned Vector3D
impl Sub for Vector3D {
    type Output = Self;

    fn sub(self, other: Self) -> Self::Output {
        Vector3D(self.0 - other.0)
    }
}

// Subtraction for &Vector3D
impl Sub<&Vector3D> for Vector3D {
    type Output = Self;

    fn sub(self, other: &Vector3D) -> Self::Output {
        Vector3D(self.0 - other.0)
    }
}

impl Sub<Vector3D> for &Vector3D {
    type Output = Vector3D;

    fn sub(self, other: Vector3D) -> Self::Output {
        Vector3D(self.0 - other.0)
    }
}

impl Sub<&Vector3D> for &Vector3D {
    type Output = Vector3D;

    fn sub(self, other: &Vector3D) -> Self::Output {
        Vector3D(self.0 - other.0)
    }
}

// Scalar multiplication for owned Vector3D
impl Mul<f32> for Vector3D {
    type Output = Self;

    fn mul(self, scalar: f32) -> Self::Output {
        Vector3D(self.0 * scalar)
    }
}

// Scalar multiplication for &Vector3D
impl Mul<f32> for &Vector3D {
    type Output = Vector3D;

    fn mul(self, scalar: f32) -> Self::Output {
        Vector3D(self.0 * scalar)
    }
}

// Scalar division for owned Vector3D
impl Div<f32> for Vector3D {
    type Output = Self;

    fn div(self, scalar: f32) -> Self::Output {
        Vector3D(self.0 / scalar)
    }
}

// Scalar division for &Vector3D
impl Div<f32> for &Vector3D {
    type Output = Vector3D;

    fn div(self, scalar: f32) -> Self::Output {
        Vector3D(self.0 / scalar)
    }
}

impl Vector3D {
    /// Create a new `Vector3D` structure.
    #[inline]
    pub fn new(x: f32, y: f32, z: f32) -> Self {
        Vector3D(Vector3::new(x, y, z))
    }

    /// Calculate length of the vector.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vector = Vector3D::new(1.0, 2.0, 3.0);
    /// assert_approx_eq!(f32, vector.len(), 3.741657);
    /// ```
    #[inline]
    pub fn len(&self) -> f32 {
        self.magnitude()
    }

    /// Convert vector to unit vector.
    ///
    /// ## Notes
    /// - Returns itself when applied to a null vector.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vector = Vector3D::new(1.0, 2.0, 3.0).to_unit();
    ///
    /// assert_approx_eq!(f32, vector.x, 0.2672612);
    /// assert_approx_eq!(f32, vector.y, 0.5345225);
    /// assert_approx_eq!(f32, vector.z, 0.8017837);
    /// assert_approx_eq!(f32, vector.len(), 1.0);
    /// ```
    #[inline]
    pub fn to_unit(self) -> Vector3D {
        Vector3D(self.normalize())
    }

    /// Invert the vector. (Reverse direction of the vector.)
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vector = Vector3D::new(1.0, -2.0, 3.0).invert();
    ///
    /// assert_approx_eq!(f32, vector.x, -1.0);
    /// assert_approx_eq!(f32, vector.y,  2.0);
    /// assert_approx_eq!(f32, vector.z, -3.0);
    /// ```
    #[inline]
    pub fn invert(self) -> Vector3D {
        Vector3D(self.0 * -1.0)
    }

    /// Calculate the angle between two vectors. Returns angle in radians.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vector1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let vector2 = Vector3D::new(3.0, 2.0, 1.0);
    ///
    /// let angle = vector1.angle(&vector2);
    ///
    /// assert_approx_eq!(f32, angle, 0.77519345);
    /// ```
    ///
    /// ## Notes
    /// - Always returns a value between 0 and π.
    #[inline]
    pub fn angle(&self, vector: &Vector3D) -> f32 {
        (self.dot(vector) / (self.len() * vector.len())).acos()
    }

    /// Shift vector in the direction of `orientation` by target distance.
    /// `orientation` does not have to be a unit vector.
    ///
    /// ## Warning
    /// Does not take periodic boundary conditions into consideration.
    /// If you want the point to fit into the simulation box,
    /// apply [Vector3D::wrap] after shifting.
    ///
    /// ## Example
    /// Shift a given point in space by 2 nm (in total) along x and y dimensions.
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let mut vector = Vector3D::new(1.0, 2.0, 3.0);
    /// let orientation = Dimension::XY.into();
    ///
    /// // shifting along each of the x and y dimensions by √2 nm
    /// vector.shift(orientation, 2.0);
    ///
    /// assert_approx_eq!(f32, vector.x, 2.4142137);
    /// assert_approx_eq!(f32, vector.y, 3.4142137);
    /// assert_approx_eq!(f32, vector.z, 3.0);
    /// ```
    #[inline]
    pub fn shift(&mut self, orientation: Vector3D, distance: f32) {
        let unit = orientation.to_unit();

        self.0 += unit.0 * distance;
    }

    /// Rotate a point in space using a rotation matrix.
    ///
    /// ## Warning
    /// Does not take periodic boundary conditions into consideration.
    /// If you want the point to fit into the simulation box,
    /// apply [Vector3D::wrap] after rotating.
    ///
    /// ## Exampless
    /// Rotate the given point by +90° (counterclockwise) around the z-axis:
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// # use nalgebra::Matrix3;
    /// #
    /// let point = Vector3D::new(1.0, 2.0, 3.0);
    /// let rotation = Matrix3::new(
    ///     0.0, -1.0,  0.0,
    ///     1.0,  0.0,  0.0,
    ///     0.0,  0.0,  1.0,
    /// );
    ///
    /// let rotated = point.rotate(&rotation);
    /// assert_approx_eq!(f32, rotated.x, -2.0);
    /// assert_approx_eq!(f32, rotated.y, 1.0);
    /// assert_approx_eq!(f32, rotated.z, 3.0);
    /// ```
    ///
    /// Rotate the given point by -45° (clockwise) around the x-axis:
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// # use nalgebra::Matrix3;
    /// #
    /// // Clockwise 45° rotation around the X-axis
    /// let rotation = Matrix3::new(
    ///    1.0000,  0.0000, 0.0000,
    ///    0.0000,  0.7071, 0.7071,
    ///    0.0000, -0.7071, 0.7071,
    /// );
    ///
    /// let point = Vector3D::new(1.0, 2.0, 3.0);
    /// let rotated = point.rotate(&rotation);
    ///
    /// assert_approx_eq!(f32, rotated.x, 1.0000);
    /// assert_approx_eq!(f32, rotated.y, 3.5355);
    /// assert_approx_eq!(f32, rotated.z, 0.7071);
    /// ```
    #[inline(always)]
    pub fn rotate(self, rotation_matrix: &Matrix3<f32>) -> Vector3D {
        Vector3D(rotation_matrix * self.deref())
    }

    /// Wrap coordinates of `Vector3D` so that each of them fits into the simulation box.
    /// Assumes orthogonal simulation box.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let mut point = Vector3D::new(-0.5, 2.0, 4.2);
    /// let simbox = SimBox::from([4.0, 4.0, 4.0]);
    ///
    /// point.wrap(&simbox);
    /// assert_approx_eq!(f32, point.x, 3.5, epsilon = 0.00001);
    /// assert_approx_eq!(f32, point.y, 2.0, epsilon = 0.00001);
    /// assert_approx_eq!(f32, point.z, 0.2, epsilon = 0.00001);
    /// ```
    #[inline(always)]
    pub fn wrap(&mut self, sbox: &SimBox) {
        self.x = Vector3D::wrap_coordinate(self.0.x, sbox.x);
        self.y = Vector3D::wrap_coordinate(self.0.y, sbox.y);
        self.z = Vector3D::wrap_coordinate(self.0.z, sbox.z);
    }

    /// Wrap a single coordinate into a simulation box.
    ///
    /// ## Panics
    /// Panics if `box_len` is exactly equal to 0.
    ///
    /// ## Note on performance
    /// You may think that the body of this function should look rather like this:
    /// ```ignore
    /// coor - box_len * (coor / box_len).floor()
    /// ```
    ///
    /// However, applying `floor` to float is a surprisingly costly operation.
    /// As in almost all cases, we will only perform AT MOST one iteration through one of the loops,
    /// the "loop" version of the wrapping function is usually much faster.
    #[inline(always)]
    fn wrap_coordinate(coor: f32, box_len: f32) -> f32 {
        if box_len == 0.0 {
            panic!("FATAL GROAN ERROR | Vector3D::wrap_coordinate | Box len should not be zero.")
        }

        let mut wrapped = coor;

        while wrapped > box_len {
            wrapped -= box_len;
        }

        while wrapped < 0.0f32 {
            wrapped += box_len;
        }

        wrapped
    }

    /// Calculate distance between two points in the specified dimensions.
    /// In case a one-dimensional distance is requested, returns **oriented** distance
    /// between `self` and `point`.
    /// Takes periodic boundary conditions into consideration.
    ///
    /// ## Warning
    /// - Currently only works with orthogonal simulation boxes.
    ///
    /// ## Example 1: Two-dimensional distance
    /// Calculate distance between two points in the xy-plane.
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let point1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let point2 = Vector3D::new(3.5, 1.0, 2.0);
    ///
    /// let simbox = SimBox::from([4.0, 4.0, 4.0]);
    ///
    /// let distance = point1.distance(&point2, Dimension::XY, &simbox);
    /// assert_approx_eq!(f32, distance, 1.802776);
    /// ```
    /// ## Example 2: One-dimensional oriented distance
    /// Calculate oriented distance between two points along the x-axis.
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let point1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let point2 = Vector3D::new(3.5, 1.0, 2.0);
    ///
    /// let simbox = SimBox::from([4.0, 4.0, 4.0]);
    ///
    /// let distance1 = point1.distance(&point2, Dimension::X, &simbox);
    /// assert_approx_eq!(f32, distance1, 1.5);  // PBC are in play here, do not be confused by the sign
    /// let distance2 = point2.distance(&point1, Dimension::X, &simbox);
    /// assert_approx_eq!(f32, distance2, -1.5);
    /// ```
    #[inline]
    pub fn distance(&self, point: &Vector3D, dim: Dimension, sbox: &SimBox) -> f32 {
        match dim {
            Dimension::None => 0.0,
            Dimension::X => Vector3D::min_image(self.0.x - point.0.x, sbox.x),
            Dimension::Y => Vector3D::min_image(self.0.y - point.0.y, sbox.y),
            Dimension::Z => Vector3D::min_image(self.0.z - point.0.z, sbox.z),
            Dimension::XY => {
                let dx = Vector3D::min_image(self.0.x - point.0.x, sbox.x);
                let dy = Vector3D::min_image(self.0.y - point.0.y, sbox.y);
                Vector3::new(dx, dy, 0.0).magnitude()
            }
            Dimension::XZ => {
                let dx = Vector3D::min_image(self.0.x - point.0.x, sbox.x);
                let dz = Vector3D::min_image(self.0.z - point.0.z, sbox.z);
                Vector3::new(dx, 0.0, dz).magnitude()
            }
            Dimension::YZ => {
                let dy = Vector3D::min_image(self.0.y - point.0.y, sbox.y);
                let dz = Vector3D::min_image(self.0.z - point.0.z, sbox.z);
                Vector3::new(0.0, dy, dz).magnitude()
            }
            Dimension::XYZ => {
                let dx = Vector3D::min_image(self.0.x - point.0.x, sbox.x);
                let dy = Vector3D::min_image(self.0.y - point.0.y, sbox.y);
                let dz = Vector3D::min_image(self.0.z - point.0.z, sbox.z);
                Vector3::new(dx, dy, dz).magnitude()
            }
        }
    }

    /// Calculate distance between two points in the specified dimensions. **Ignore PBC.**
    /// In case a one-dimensional distance is requested, returns naive **oriented** distance
    /// between `self` and `point`.
    ///
    /// ## Example 1: Two-dimensional distance
    /// Calculate naive distance between two points in the xy-plane.
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let point1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let point2 = Vector3D::new(3.5, 1.0, 2.0);
    ///
    /// let distance = point1.distance_naive(&point2, Dimension::XY);
    /// assert_approx_eq!(f32, distance, 2.692582);
    /// ```
    /// ## Example 2: One-dimensional oriented distance
    /// Calculate naive oriented distance between two points along the x-axis.
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let point1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let point2 = Vector3D::new(3.5, 1.0, 2.0);
    ///
    /// let distance1 = point1.distance_naive(&point2, Dimension::X);
    /// assert_approx_eq!(f32, distance1, -2.5);
    /// let distance2 = point2.distance_naive(&point1, Dimension::X);
    /// assert_approx_eq!(f32, distance2, 2.5);
    /// ```
    ///
    /// ## Notes
    /// - If dimension is `Dimension::None`, returns 0.
    #[inline]
    pub fn distance_naive(&self, point: &Vector3D, dim: Dimension) -> f32 {
        match dim {
            Dimension::None => 0.0,
            Dimension::X => self.0.x - point.0.x,
            Dimension::Y => self.0.y - point.0.y,
            Dimension::Z => self.0.z - point.0.z,
            Dimension::XY => (self.0.xy() - point.0.xy()).magnitude(),
            Dimension::XZ => (self.0.xz() - point.0.xz()).magnitude(),
            Dimension::YZ => (self.0.yz() - point.0.yz()).magnitude(),
            Dimension::XYZ => (self.0 - point.0).magnitude(),
        }
    }

    /// Calculate shortest vector connecting `self` with `point` taking PBC into consideration.
    ///
    /// ## Warning
    /// Currently only works with rectangular simulation boxes.
    ///
    /// ## Notes
    /// - In case the real point and its periodic image are equidistant from `self`,
    ///   this function will return either of the two shortest vectors. It is not defined
    ///   which vector will be returned.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let point1 = Vector3D::new(1.0, 2.0, 3.0);
    /// let point2 = Vector3D::new(3.0, 2.0, 1.0);
    /// let simbox = SimBox::from([3.5, 5.0, 5.0]);
    ///
    /// let vec = point1.vector_to(&point2, &simbox);
    ///
    /// assert_approx_eq!(f32, vec.x, -1.5);
    /// assert_approx_eq!(f32, vec.y, 0.0);
    /// assert_approx_eq!(f32, vec.z, -2.0);
    /// ```
    #[inline]
    pub fn vector_to(&self, point: &Vector3D, sbox: &SimBox) -> Vector3D {
        let box_half = Vector3::new(sbox.x / 2.0, sbox.y / 2.0, sbox.z / 2.0);

        Vector3D::new(
            floor_mod(point.0.x - self.0.x + box_half.x, sbox.x) - box_half.x,
            floor_mod(point.0.y - self.0.y + box_half.y, sbox.y) - box_half.y,
            floor_mod(point.0.z - self.0.z + box_half.z, sbox.z) - box_half.z,
        )
    }

    /// Takes the distance and returns a new distance that is modified according to the minimum image convention.
    ///
    /// ## Panics
    /// Panics if `box_len` is exactly equal to zero.
    fn min_image(dx: f32, box_len: f32) -> f32 {
        if box_len == 0.0 {
            panic!("FATAL GROAN ERROR | Vector3D::min_image | Box len should not be zero.")
        }

        let half_box = box_len / 2.0;
        let mut new_dx = dx;

        while new_dx > half_box {
            new_dx -= box_len;
        }

        while new_dx < -half_box {
            new_dx += box_len;
        }

        new_dx
    }

    /// Apply `Dimension` as a filter for `Vector3D`.
    ///
    /// All dimensions of the `Vector3D` which do not match the `Dimension` are set to 0.
    ///
    /// ## Example
    /// ```
    /// # use groan_rs::prelude::*;
    /// #
    /// let mut vec = Vector3D::new(1.0, 2.0, 3.0);
    ///
    /// vec.filter(Dimension::XZ);
    ///
    /// assert_eq!(vec.x, 1.0);
    /// assert_eq!(vec.y, 0.0);
    /// assert_eq!(vec.z, 3.0);
    /// ```
    pub fn filter(&mut self, dim: Dimension) {
        if !dim.is_x() {
            self.0.x = 0.0;
        }

        if !dim.is_y() {
            self.0.y = 0.0;
        }

        if !dim.is_z() {
            self.0.z = 0.0;
        }
    }

    /// Returns `true` if all the fields of the vector are exactly zero.
    /// Otherwise, returns `false`.
    pub fn is_zero(&self) -> bool {
        self.0.x == 0.0 && self.0.y == 0.0 && self.0.z == 0.0
    }

    /// Get an average 3D vector from a collection of 3D vectors.
    ///
    /// ## Examples
    /// Example 1:
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vectors = [Vector3D::new(1.0, 2.0, 4.0), Vector3D::new(3.0, 2.0, -2.0)];
    /// let average = Vector3D::average(&vectors);
    ///
    /// assert_approx_eq!(f32, average.x, 2.0);
    /// assert_approx_eq!(f32, average.y, 2.0);
    /// assert_approx_eq!(f32, average.z, 1.0);
    /// ```
    ///
    /// Example 2:
    /// ```
    /// # use groan_rs::prelude::*;
    /// # use float_cmp::assert_approx_eq;
    /// #
    /// let vectors = [
    ///     Vector3D::new(-3.0, 0.0, 2.0),
    ///     Vector3D::new(-2.0, 1.0, 7.0),
    ///     Vector3D::new(1.0, -2.0, 2.0),
    /// ];
    ///
    /// let average = Vector3D::average(&vectors);
    /// assert_approx_eq!(f32, average.x, -1.333333, epsilon = 1e-4);
    /// assert_approx_eq!(f32, average.y, -0.333333, epsilon = 1e-4);
    /// assert_approx_eq!(f32, average.z, 3.6666666, epsilon = 1e-4);
    /// ```
    pub fn average(vectors: &[Vector3D]) -> Vector3D {
        let sum = vectors.iter().fold((0.0, 0.0, 0.0), |(x, y, z), vec| {
            (x + vec.x, y + vec.y, z + vec.z)
        });

        let count = vectors.len() as f32;
        Vector3D::new(sum.0 / count, sum.1 / count, sum.2 / count)
    }
}

impl Default for Vector3D {
    /// Create a zero vector.
    fn default() -> Self {
        Vector3D(Vector3::new(0.0, 0.0, 0.0))
    }
}

/******************************/
/*       FEATURE: SERDE       */
/******************************/

#[cfg(feature = "serde")]
mod serde {
    use std::fmt;

    use super::*;
    use ::serde::{
        de::{self, SeqAccess, Visitor},
        Deserialize, Deserializer,
    };
    use ::serde::{ser::SerializeSeq, Serialize, Serializer};

    impl Serialize for Vector3D {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: Serializer,
        {
            let mut seq = serializer.serialize_seq(Some(3))?; // We know the sequence length is 3
            seq.serialize_element(&self.0.x)?;
            seq.serialize_element(&self.0.y)?;
            seq.serialize_element(&self.0.z)?;
            seq.end()
        }
    }

    impl<'de> Deserialize<'de> for Vector3D {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            struct Vector3DVisitor;

            impl<'de> Visitor<'de> for Vector3DVisitor {
                type Value = Vector3D;

                fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                    formatter.write_str("a sequence of three floats")
                }

                fn visit_seq<S>(self, mut seq: S) -> Result<Vector3D, S::Error>
                where
                    S: SeqAccess<'de>,
                {
                    let x = seq
                        .next_element()?
                        .ok_or_else(|| serde::de::Error::invalid_length(0, &self))?;
                    let y = seq
                        .next_element()?
                        .ok_or_else(|| serde::de::Error::invalid_length(1, &self))?;
                    let z = seq
                        .next_element()?
                        .ok_or_else(|| serde::de::Error::invalid_length(2, &self))?;
                    Ok(Vector3D(Vector3::new(x, y, z)))
                }
            }

            deserializer.deserialize_seq(Vector3DVisitor)
        }
    }
}

/******************************/
/*         UNIT TESTS         */
/******************************/

#[cfg(test)]
mod tests {
    use super::*;
    use float_cmp::assert_approx_eq;

    #[test]
    fn display() {
        let vec = Vector3D::new(4.32174, 5.6245, 1.212094);
        assert_eq!(vec.to_string(), String::from("[4.32174, 5.6245, 1.212094]"));
    }

    #[test]
    fn len() {
        let vec = Vector3D::new(4.3, 5.6, 1.2);
        assert_approx_eq!(f32, vec.len(), 7.161704);
    }

    #[test]
    fn len_null() {
        let vec = Vector3D::new(0.0, 0.0, 0.0);
        assert_approx_eq!(f32, vec.len(), 0.0);
    }

    #[test]
    fn to_unit() {
        let vec = Vector3D::new(4.3, 5.6, 1.2).to_unit();

        assert_approx_eq!(f32, vec.x, 0.6004158);
        assert_approx_eq!(f32, vec.y, 0.7819368);
        assert_approx_eq!(f32, vec.z, 0.16755791);
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn to_unit_null() {
        let vec = Vector3D::new(0.0, 0.0, 0.0).to_unit();

        assert!(vec.x.is_nan());
        assert!(vec.y.is_nan());
        assert!(vec.z.is_nan());
    }

    #[test]
    fn to_unit_small() {
        let vec = Vector3D::new(0.13, 0.0, 0.0).to_unit();

        assert_approx_eq!(f32, vec.x, 1.0);
        assert_approx_eq!(f32, vec.y, 0.0);
        assert_approx_eq!(f32, vec.z, 0.0);
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn dot_1() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(0.0, 1.0, 1.0);

        assert_approx_eq!(f32, vector1.dot(&vector2), 0.0);
    }

    #[test]
    fn dot_2() {
        let vector1 = Vector3D::new(2.0, 3.0, 4.0);
        let vector2 = Vector3D::new(1.0, 2.0, 3.0);

        assert_approx_eq!(f32, vector1.dot(&vector2), 20.0);
    }

    #[test]
    fn dot_3() {
        let vector1 = Vector3D::new(-2.0, 0.0, 5.0);
        let vector2 = Vector3D::new(3.0, 1.0, -4.0);

        assert_approx_eq!(f32, vector1.dot(&vector2), -26.0);
    }

    #[test]
    fn dot_4() {
        let vector1 = Vector3D::new(-2.0, 0.0, 5.0);
        let vector2 = Vector3D::new(-3.0, 1.0, -4.0);

        assert_approx_eq!(f32, vector1.dot(&vector2), -14.0);
    }

    #[test]
    fn dot_5() {
        let vector1 = Vector3D::new(-2.5, 0.3, 5.1);
        let vector2 = Vector3D::new(-3.9, 1.1, -4.2);

        assert_approx_eq!(f32, vector1.dot(&vector2), -11.34);
    }

    #[test]
    fn cross_1() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(0.0, 1.0, 1.0);

        let cross = vector1.cross(&vector2);
        assert_approx_eq!(f32, cross.x, 0.0);
        assert_approx_eq!(f32, cross.y, -1.0);
        assert_approx_eq!(f32, cross.z, 1.0);
    }

    #[test]
    fn cross_2() {
        let vector1 = Vector3D::new(2.0, 3.0, 4.0);
        let vector2 = Vector3D::new(1.0, 2.0, 3.0);

        let cross = vector1.cross(&vector2);
        assert_approx_eq!(f32, cross.x, 1.0);
        assert_approx_eq!(f32, cross.y, -2.0);
        assert_approx_eq!(f32, cross.z, 1.0);
    }

    #[test]
    fn cross_3() {
        let vector1 = Vector3D::new(-2.0, 0.0, 5.0);
        let vector2 = Vector3D::new(3.0, 1.0, -4.0);

        let cross = vector1.cross(&vector2);
        assert_approx_eq!(f32, cross.x, -5.0);
        assert_approx_eq!(f32, cross.y, 7.0);
        assert_approx_eq!(f32, cross.z, -2.0);
    }

    #[test]
    fn cross_4() {
        let vector1 = Vector3D::new(-2.0, 0.0, 5.0);
        let vector2 = Vector3D::new(-3.0, 1.0, -4.0);

        let cross = vector1.cross(&vector2);
        assert_approx_eq!(f32, cross.x, -5.0);
        assert_approx_eq!(f32, cross.y, -23.0);
        assert_approx_eq!(f32, cross.z, -2.0);
    }

    #[test]
    fn cross_5() {
        let vector1 = Vector3D::new(-2.5, 0.3, 5.1);
        let vector2 = Vector3D::new(-3.9, 1.1, -4.2);

        let cross = vector1.cross(&vector2);
        assert_approx_eq!(f32, cross.x, -6.87);
        assert_approx_eq!(f32, cross.y, -30.39);
        assert_approx_eq!(f32, cross.z, -1.58);
    }

    #[test]
    fn angle_1() {
        let vector1 = Vector3D::new(2.0, 0.0, 0.0);
        let vector2 = Vector3D::new(0.0, 2.0, 0.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), std::f32::consts::FRAC_PI_2);
    }

    #[test]
    fn angle_2() {
        let vector1 = Vector3D::new(2.0, 0.0, 0.0);
        let vector2 = Vector3D::new(0.0, -2.0, 0.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), std::f32::consts::FRAC_PI_2);
    }

    #[test]
    fn angle_3() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(0.0, 0.0, 7.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), std::f32::consts::FRAC_PI_2);
    }

    #[test]
    fn angle_4() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(3.0, 0.0, 3.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), std::f32::consts::FRAC_PI_4);
    }

    #[test]
    fn angle_5() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(4.0, 0.0, 0.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), 0.0);
    }

    #[test]
    fn angle_6() {
        let vector1 = Vector3D::new(1.0, 0.0, 0.0);
        let vector2 = Vector3D::new(-4.0, 0.0, 0.0);

        assert_approx_eq!(f32, vector1.angle(&vector2), std::f32::consts::PI);
    }

    #[test]
    fn angle_7() {
        let vector1 = Vector3D::new(1.0, -1.0, 3.5);
        let vector2 = Vector3D::new(1.2, 2.4, -0.7);

        assert_approx_eq!(f32, vector1.angle(&vector2), 1.9269546);
    }

    #[test]
    fn shift_x() {
        let mut vector = Vector3D::new(-2.5, 0.3, 5.1);
        let orientation = Vector3D::from(Dimension::X);

        vector.shift(orientation, 1.5);

        assert_approx_eq!(f32, vector.x, -1.0);
        assert_approx_eq!(f32, vector.y, 0.3);
        assert_approx_eq!(f32, vector.z, 5.1);
    }

    #[test]
    fn shift_xyz() {
        let mut vector = Vector3D::new(-2.5, 0.3, 5.1);
        let orientation = Vector3D::from(Dimension::XYZ);

        vector.shift(orientation, 3.5);

        assert_approx_eq!(f32, vector.x, -0.479274);
        assert_approx_eq!(f32, vector.y, 2.320726);
        assert_approx_eq!(f32, vector.z, 7.120726);

        assert_approx_eq!(
            f32,
            vector.distance_naive(&[-2.5, 0.3, 5.1].into(), Dimension::XYZ),
            3.5
        );
    }

    #[test]
    fn shift_arbitrary() {
        let mut vector = Vector3D::new(-2.5, 0.3, 5.1);
        let orientation = Vector3D::new(1.0, 0.5, 2.0);

        vector.shift(orientation, 4.2);

        assert_approx_eq!(f32, vector.x, -0.66697); // shifted by 1.833
        assert_approx_eq!(f32, vector.y, 1.216515); // shifted by 0.917
        assert_approx_eq!(f32, vector.z, 8.76606); // shifted by 3.666

        assert_approx_eq!(
            f32,
            vector.distance_naive(&[-2.5, 0.3, 5.1].into(), Dimension::XYZ),
            4.2
        );
    }

    #[test]
    fn shift_arbitrary_negative() {
        let mut vector = Vector3D::new(-2.5, 0.3, 5.1);
        let orientation = Vector3D::new(1.0, 0.5, 2.0);

        vector.shift(orientation, -4.2);

        assert_approx_eq!(f32, vector.x, -4.33303); // shifted by -1.833
        assert_approx_eq!(f32, vector.y, -0.616515); // shifted by -0.917
        assert_approx_eq!(f32, vector.z, 1.43394); // shifted by -3.666

        assert_approx_eq!(
            f32,
            vector.distance_naive(&[-2.5, 0.3, 5.1].into(), Dimension::XYZ),
            4.2
        );
    }

    #[test]
    fn wrap() {
        let mut vector1 = Vector3D::new(-1.0, 1.5, 3.0);
        let mut vector2 = Vector3D::new(2.0, 2.2, -0.3);
        let mut vector3 = Vector3D::new(-54.2, 77.8, 124.5);
        let simbox = SimBox::from([2.0, 2.0, 2.0]);

        vector1.wrap(&simbox);
        assert_approx_eq!(f32, vector1.x, 1.0);
        assert_approx_eq!(f32, vector1.y, 1.5);
        assert_approx_eq!(f32, vector1.z, 1.0);

        vector2.wrap(&simbox);
        assert_approx_eq!(f32, vector2.x, 2.0);
        assert_approx_eq!(f32, vector2.y, 0.2);
        assert_approx_eq!(f32, vector2.z, 1.7);

        vector3.wrap(&simbox);
        assert_approx_eq!(f32, vector3.x, 1.8, epsilon = 0.00001);
        assert_approx_eq!(f32, vector3.y, 1.8, epsilon = 0.00001);
        assert_approx_eq!(f32, vector3.z, 0.5, epsilon = 0.00001);
    }

    #[test]
    fn distance_x() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::X, &simbox),
            1.5,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::X, &simbox),
            -1.5,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_y() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::Y, &simbox),
            -0.2,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::Y, &simbox),
            0.2,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_z() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::Z, &simbox),
            -1.8,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::Z, &simbox),
            1.8,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_xy() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::XY, &simbox),
            1.51327,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::XY, &simbox),
            1.51327,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_xz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::XZ, &simbox),
            2.34307,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::XZ, &simbox),
            2.34307,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_yz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::YZ, &simbox),
            1.81108,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::YZ, &simbox),
            1.81108,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_xyz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(
            f32,
            point1.distance(&point2, Dimension::XYZ, &simbox),
            2.351595,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance(&point1, Dimension::XYZ, &simbox),
            2.351595,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_xyz_outofbox() {
        let point1 = Vector3D::new(-1.0, 4.5, 2.3);
        let point2 = Vector3D::new(3.5, -0.5, 4.2);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(f32, point1.distance(&point2, Dimension::X, &simbox), -0.5);
        assert_approx_eq!(f32, point1.distance(&point2, Dimension::Y, &simbox), 1.0);
        assert_approx_eq!(f32, point1.distance(&point2, Dimension::Z, &simbox), -1.9);
    }

    #[test]
    fn distance_none() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        let simbox = SimBox::from([4.0, 4.0, 4.0]);

        assert_approx_eq!(f32, point1.distance(&point2, Dimension::None, &simbox), 0.0);
        assert_approx_eq!(f32, point2.distance(&point1, Dimension::None, &simbox), 0.0);
    }

    #[test]
    fn distance_naive_x() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::X),
            -2.5,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::X),
            2.5,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_y() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::Y),
            3.8,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::Y),
            -3.8,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_z() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::Z),
            2.2,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::Z),
            -2.2,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_xy() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::XY),
            4.548626,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::XY),
            4.548626,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_xz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::XZ),
            3.330165,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::XZ),
            3.330165,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_yz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::YZ),
            4.3909,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::YZ),
            4.3909,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_xyz() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::XYZ),
            5.052722,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::XYZ),
            5.052722,
            epsilon = 0.00001
        );
    }

    #[test]
    fn distance_naive_none() {
        let point1 = Vector3D::new(1.0, 3.9, 2.6);
        let point2 = Vector3D::new(3.5, 0.1, 0.4);

        assert_approx_eq!(
            f32,
            point1.distance_naive(&point2, Dimension::None),
            0.0,
            epsilon = 0.00001
        );
        assert_approx_eq!(
            f32,
            point2.distance_naive(&point1, Dimension::None),
            0.0,
            epsilon = 0.00001
        );
    }

    #[test]
    fn vector_to_nopbc() {
        let p1 = Vector3D::new(4.0, 4.0, 5.0);
        let p2 = Vector3D::new(5.0, 5.0, 3.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x, 1.0);
        assert_approx_eq!(f32, vec.y, 1.0);
        assert_approx_eq!(f32, vec.z, -2.0);
    }

    #[test]
    fn vector_to_one_dim() {
        let p1 = Vector3D::new(3.0, 0.0, 7.0);
        let p2 = Vector3D::new(1.0, 2.0, 1.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x, -2.0);
        assert_approx_eq!(f32, vec.y, 2.0);
        assert_approx_eq!(f32, vec.z, 4.0);
    }

    #[test]
    fn vector_to_two_dim() {
        let p1 = Vector3D::new(1.0, 2.0, 5.0);
        let p2 = Vector3D::new(9.0, 8.0, 6.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x, -2.0);
        assert_approx_eq!(f32, vec.y, -4.0);
        assert_approx_eq!(f32, vec.z, 1.0);
    }

    #[test]
    fn vector_to_all_dim() {
        let p1 = Vector3D::new(8.0, 9.0, 2.0);
        let p2 = Vector3D::new(1.0, 3.0, 9.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x, 3.0);
        assert_approx_eq!(f32, vec.y, 4.0);
        assert_approx_eq!(f32, vec.z, -3.0);
    }

    #[test]
    fn vector_to_same() {
        let p1 = Vector3D::new(0.0, 3.0, 10.0);
        let p2 = Vector3D::new(10.0, 3.0, 0.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x, 0.0);
        assert_approx_eq!(f32, vec.y, 0.0);
        assert_approx_eq!(f32, vec.z, 0.0);
    }

    #[test]
    fn vector_to_equidistant() {
        let p1 = Vector3D::new(7.0, 4.0, 3.0);
        let p2 = Vector3D::new(2.0, 5.0, 2.0);
        let simbox = SimBox::from([10.0, 10.0, 10.0]);

        let vec = p1.vector_to(&p2, &simbox);

        assert_approx_eq!(f32, vec.x.abs(), 5.0);
        assert_approx_eq!(f32, vec.y, 1.0);
        assert_approx_eq!(f32, vec.z, -1.0);
    }

    #[test]
    fn filter_vec_x() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::X);
        assert_eq!(vec, [4.3, 0.0, 0.0].into());
    }

    #[test]
    fn filter_vec_y() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::Y);
        assert_eq!(vec, [0.0, 1.8, 0.0].into());
    }

    #[test]
    fn filter_vec_z() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::Z);
        assert_eq!(vec, [0.0, 0.0, 2.7].into());
    }

    #[test]
    fn filter_vec_xy() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::XY);
        assert_eq!(vec, [4.3, 1.8, 0.0].into());
    }

    #[test]
    fn filter_vec_xz() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::XZ);
        assert_eq!(vec, [4.3, 0.0, 2.7].into());
    }

    #[test]
    fn filter_vec_yz() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::YZ);
        assert_eq!(vec, [0.0, 1.8, 2.7].into());
    }

    #[test]
    fn filter_vec_xyz() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::XYZ);
        assert_eq!(vec, [4.3, 1.8, 2.7].into());
    }

    #[test]
    fn filter_vec_none() {
        let mut vec = Vector3D::new(4.3, 1.8, 2.7);
        vec.filter(Dimension::None);
        assert_eq!(vec, [0.0, 0.0, 0.0].into());
    }

    #[test]
    fn dim_to_vector_none() {
        let vec = Vector3D::from(Dimension::None);
        assert_eq!(vec, [0.0, 0.0, 0.0].into());
    }

    #[test]
    fn dim_to_vector_x() {
        let vec = Vector3D::from(Dimension::X);
        assert_eq!(vec, [1.0, 0.0, 0.0].into());
    }

    #[test]
    fn dim_to_vector_y() {
        let vec = Vector3D::from(Dimension::Y);
        assert_eq!(vec, [0.0, 1.0, 0.0].into());
    }

    #[test]
    fn dim_to_vector_z() {
        let vec = Vector3D::from(Dimension::Z);
        assert_eq!(vec, [0.0, 0.0, 1.0].into());
    }

    #[test]
    fn dim_to_vector_xy() {
        let vec = Vector3D::from(Dimension::XY);
        assert_eq!(vec, [REC_SQRT2, REC_SQRT2, 0.0].into());
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn dim_to_vector_xz() {
        let vec = Vector3D::from(Dimension::XZ);
        assert_eq!(vec, [REC_SQRT2, 0.0, REC_SQRT2].into());
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn dim_to_vector_yz() {
        let vec = Vector3D::from(Dimension::YZ);
        assert_eq!(vec, [0.0, REC_SQRT2, REC_SQRT2].into());
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn dim_to_vector_xyz() {
        let vec = Vector3D::from(Dimension::XYZ);
        assert_eq!(vec, [REC_SQRT3, REC_SQRT3, REC_SQRT3].into());
        assert_approx_eq!(f32, vec.len(), 1.0);
    }

    #[test]
    fn is_zero() {
        let vec = Vector3D::default();
        assert!(vec.is_zero());

        let vec = Vector3D::new(0.00001, 0.00001, 0.00001);
        assert!(!vec.is_zero());

        let vec = Vector3D::new(1.2, 0.4, 3.2);
        assert!(!vec.is_zero());
    }
}

#[cfg(test)]
#[cfg(feature = "serde")]
mod serde_tests {
    use float_cmp::assert_approx_eq;

    use super::*;

    #[test]
    fn vector3d_to_yaml() {
        let vector = Vector3D::new(4.376, 2.13, 4.0);

        let string = serde_yaml::to_string(&vector).unwrap();

        assert_eq!(string, "- 4.376\n- 2.13\n- 4.0\n");
    }

    #[test]
    fn vector3d_from_yaml() {
        let string = "[ 4.376, 2.13, 4.0 ]\n";
        let vector: Vector3D = serde_yaml::from_str(string).unwrap();

        assert_approx_eq!(f32, vector.x, 4.376);
        assert_approx_eq!(f32, vector.y, 2.13);
        assert_approx_eq!(f32, vector.z, 4.0);
    }
}