semeion 0.9.1

use std::ops::{Add, Sub};

/// A Point in 2D space.
#[derive(Debug, Default, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct Point<T> {
    pub x: T,
    pub y: T,
}

/// The dimension of a rectangular grid as the integer number of columns and rows.
#[derive(Debug, Default, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct Dimension {
    pub x: i32,
    pub y: i32,
}

/// The size of a graphic element represented as number of pixels.
#[derive(Debug, Default, Copy, Clone, PartialEq)]
pub struct Size {
    pub width: f32,
    pub height: f32,
}

/// Represents the location of an entity within the environment as pair of
/// coordinate that identify the environment grid tile.
pub type Location = Point<i32>;

/// Represents an offset from an Entity location within the environment.
pub type Offset = Point<i32>;

/// Represents the location of an entity within the environment expressed in
/// pixel coordinates.
pub type Coordinate = Point<f32>;

/// The scope of an Entity.
///
/// The scope of an Entity represents the maximum distance between the tile
/// where the Entity is located, and the farthest possible tile the Entity can
/// see or influence.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub struct Scope(usize);

/// The different representations of distances between two Locations.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum Distance {
    /// The straight line distance between two points.
    Euclidean,
    /// The distance between two points measured along axes at right angles.
    Manhattan,
}

impl Default for Distance {
    /// Gets the Euclidean distance representation.
    fn default() -> Self {
        Self::Euclidean
    }
}

impl Coordinate {
    /// Gets the origin coordinates in (0.0, 0.0).
    pub const fn origin() -> Self {
        Self { x: 0.0, y: 0.0 }
    }
}

impl Location {
    /// Gets the origin coordinates in (0, 0).
    pub const fn origin() -> Self {
        Self { x: 0, y: 0 }
    }

    /// Gets the distance between self and the given location according to a
    /// specific representation.
    pub fn distance(self, other: Self, representation: Distance) -> usize {
        match representation {
            Distance::Euclidean => {
                let x2 = self.x.saturating_sub(other.x).pow(2) as f64;
                let y2 = self.y.saturating_sub(other.y).pow(2) as f64;
                (x2 + y2).sqrt() as usize
            }
            Distance::Manhattan => {
                let x = self.x.saturating_sub(other.x).abs();
                let y = self.y.saturating_sub(other.y).abs();
                (x + y) as usize
            }
        }
    }

    /// Converts the Point into a point expressed as pixel coordinates, according
    /// to the length of each grid square side.
    pub fn to_pixel_coords(self, side: f32) -> Coordinate {
        Coordinate {
            x: self.x as f32 * side,
            y: self.y as f32 * side,
        }
    }

    /// Maps a 2-dimensional coordinate in a Torus of the given dimension, to a
    /// 1-dimensional index.
    pub fn one_dimensional(self, dimension: impl Into<Dimension>) -> usize {
        debug_assert!(!self.x.is_negative());
        debug_assert!(!self.y.is_negative());
        let dimension = dimension.into();
        let pos = self.y.saturating_mul(dimension.x).saturating_add(self.x);
        debug_assert!(!pos.is_negative());
        debug_assert!(pos < dimension.x.saturating_mul(dimension.y));
        pos as usize
    }

    /// Maps a 1-dimensional index to a 2-dimensional Location in a Torus of
    /// the given dimension.
    pub fn from_one_dimensional(
        index: usize,
        dimension: impl Into<Dimension>,
    ) -> Self {
        let dimension = dimension.into();
        debug_assert!(dimension.x.is_positive());
        Self {
            x: index as i32 % dimension.x,
            y: index as i32 / dimension.x,
        }
    }

    /// Translates the Location coordinates by the given Offset, while keeping the
    /// final Location within a Torus with the given dimension.
    ///
    /// Returns a reference to the final location.
    pub fn translate(
        &mut self,
        offset: impl Into<Offset>,
        dimension: impl Into<Dimension>,
    ) -> &mut Self {
        let offset = offset.into();
        let dimension = dimension.into();
        self.x = self.x.saturating_add(offset.x).rem_euclid(dimension.x);
        self.y = self.y.saturating_add(offset.y).rem_euclid(dimension.y);
        self
    }

    /// Translates the Location coordinates towards the given destination,
    /// offsetting the current values by a single unit (both abscissa and
    /// ordinate), while keeping the final Location within a Torus with the
    /// given dimension.
    ///
    /// Between all the possible paths to the final destination, the shortest
    /// one is chosen.
    /// Returns a reference to the final location.
    pub fn translate_towards(
        &mut self,
        destination: impl Into<Self>,
        dimension: impl Into<Dimension>,
    ) -> &mut Self {
        let dimension = dimension.into();
        let destination = destination.into();
        let x = destination
            .x
            .rem_euclid(dimension.x)
            .saturating_sub(self.x)
            .signum();
        let y = destination
            .y
            .rem_euclid(dimension.y)
            .saturating_sub(self.y)
            .signum();
        self.translate(Offset { x, y }, dimension)
    }
}

impl From<(i32, i32)> for Location {
    fn from((x, y): (i32, i32)) -> Self {
        Self { x, y }
    }
}

impl From<Location> for (i32, i32) {
    fn from(location: Location) -> Self {
        (location.x, location.y)
    }
}

impl Offset {
    /// Gets a list of offsets from a central location in a grid, to all the tiles
    /// located in its border, according to the given distance between the tile
    /// in the center and the border (Scope), in arbitrary order. Returns a
    /// single Offset equal to the origin (0, 0) if the given Scope is equal to
    /// 0.
    pub fn border(scope: impl Into<Scope>) -> Vec<Offset> {
        let scope = scope.into();
        let delta = scope.magnitude() as i32;
        if delta == 0 {
            return vec![Offset::origin()];
        }

        let mut offsets =
            Vec::with_capacity(Dimension::perimeter_with_scope(scope));
        // top and bottom rows of the border
        for &y in &[-delta, delta] {
            for x in -delta..=delta {
                offsets.push(Offset { x, y });
            }
        }
        // left and right columns of the border (without corners)
        for y in 1i32.saturating_sub(delta)..=delta.saturating_sub(1) {
            for &x in &[-delta, delta] {
                offsets.push(Offset { x, y });
            }
        }

        debug_assert!(!offsets.is_empty());
        offsets
    }

    /// Gets a list of offsets from a central location in  a grid, to all the 4
    /// tiles located in the corners of its border, according to the given
    /// distance between the tile in the center and the border (Scope), in
    /// arbitrary order.
    pub fn corners(scope: impl Into<Scope>) -> [Offset; 4] {
        let delta = scope.into().magnitude() as i32;
        [
            (-delta, -delta).into(),
            (-delta, delta).into(),
            (delta, -delta).into(),
            (delta, delta).into(),
        ]
    }
}

impl Size {
    /// Gets the Coordinate of the center of this Size.
    pub fn center(self) -> Coordinate {
        Coordinate {
            x: self.width / 2.0,
            y: self.height / 2.0,
        }
    }

    /// Converts the Size to a Dimension according to the given side length.
    pub fn to_dimension(self, side: f32) -> Dimension {
        Dimension {
            x: (self.width / side) as i32,
            y: (self.height / side) as i32,
        }
    }
}

impl From<(f32, f32)> for Size {
    fn from((width, height): (f32, f32)) -> Self {
        Self { width, height }
    }
}

impl From<Size> for (f32, f32) {
    fn from(size: Size) -> Self {
        (size.width, size.height)
    }
}

impl Dimension {
    /// Constructs new dimension where the overall rectangle is composed by the
    /// lowest number of rectangles of equal size lower than the given `count`,
    /// so that they should be aligned in such a manner that the number of rows
    /// and number of columns are equal (with the last row possibly not being
    /// completely filled).
    pub fn with_eq_rectangles(count: usize) -> Self {
        debug_assert_ne!(count, 0);
        let count = count as f64;
        let x = count.sqrt().ceil();
        let y = (count / x).ceil();
        Self {
            x: x as i32,
            y: y as i32,
        }
    }

    /// Gets the number of tiles in a grid of given Dimension, equal to the
    /// number of row by the number of columns.
    pub fn len(self) -> usize {
        debug_assert!(!self.x.is_negative());
        debug_assert!(!self.y.is_negative());
        self.x.saturating_mul(self.y) as usize
    }

    /// Returns true only if the number of tiles in the grid is 0.
    pub fn is_empty(self) -> bool {
        self.len() == 0
    }

    /// Returns true only if the components of this Dimension are equal in magnitude,
    /// that is, `self.x == self.y`, and therefore this Dimension represents a square.
    pub fn is_square(self) -> bool {
        self.x == self.y
    }

    /// Gets the Location of the center of this Dimension.
    pub fn center(self) -> Location {
        Location {
            x: self.x / 2,
            y: self.y / 2,
        }
    }

    /// Returns true only if the given Location is within this Dimension.
    pub fn contains(self, location: impl Into<Location>) -> bool {
        debug_assert!(self.x >= 0 && self.y >= 0);
        let location = location.into();
        !(location.x < 0
            || location.x >= self.x
            || location.y < 0
            || location.y >= self.y)
    }

    /// Gets the aspect ratio of this Dimension.
    pub fn aspect_ratio(self) -> f32 {
        self.x as f32 / self.y as f32
    }

    /// Maps self with the given Dimension, and returns the number of rows and
    /// columns (as new Dimension) that each tile of the given Dimension would
    /// have to occupy so that all its tiles would fill up self.
    pub fn scale(self, other: impl Into<Self>) -> Self {
        let other = other.into();
        Self {
            x: other.x / self.x,
            y: other.y / self.y,
        }
    }

    /// Gets the length of the side of a squared grid (where the number of rows
    /// is equal to the number of columns), given a specific scope (maximum
    /// distance from the center tile of the grid to the farthest).
    pub(crate) fn side_with_scope(scope: impl Into<Scope>) -> usize {
        1 + scope.into().magnitude().saturating_sub(1) * 2
    }

    /// Gets the perimeter of a squared grid (where the number of rows is equal
    /// to the number of columns), given a specific scope (maximum distance from
    /// the center tile of the grid to the farthest).
    pub(crate) fn perimeter_with_scope(scope: impl Into<Scope>) -> usize {
        let scope = scope.into();
        match scope.magnitude() {
            0 => 1,
            _ => Self::side_with_scope(scope) * 4 + 4,
        }
    }

    /// Gets the number of elements in a squared grid (where the number of rows
    /// is equal to the number of columns), given a specific scope (maximum
    /// distance from the center tile of the grid to the farthest).
    pub(crate) fn len_with_scope(scope: impl Into<Scope>) -> usize {
        let scope = scope.into();
        match scope.magnitude() {
            0 => 1,
            _ => {
                Self::len_with_scope(scope.magnitude() - 1)
                    + Self::perimeter_with_scope(scope)
            }
        }
    }
}

impl From<(i32, i32)> for Dimension {
    fn from((x, y): (i32, i32)) -> Self {
        Self { x, y }
    }
}

impl From<Dimension> for (i32, i32) {
    fn from(dimension: Dimension) -> Self {
        (dimension.x, dimension.y)
    }
}

impl From<usize> for Scope {
    fn from(magnitude: usize) -> Self {
        Self(magnitude)
    }
}

impl From<Scope> for usize {
    fn from(scope: Scope) -> Self {
        scope.0
    }
}

impl Scope {
    /// Constructs a new Scope of the given magnitude.
    pub fn with_magnitude(magnitude: usize) -> Self {
        Self(magnitude)
    }

    /// Constructs a new Scope with no magnitude.
    pub fn empty() -> Self {
        Self::with_magnitude(0)
    }

    /// Gets the magnitude of this Scope, that is its value.
    pub fn magnitude(self) -> usize {
        self.0
    }

    /// Returns true only if the area covered by the neighborhood of an Entity
    /// with such Scope, would be bigger (in the x or y dimension) of the given
    /// Dimension.
    pub(crate) fn overflows(self, dimension: impl Into<Dimension>) -> bool {
        let side = Dimension::side_with_scope(self) as i32;
        let dimension = dimension.into();
        side > dimension.x || side > dimension.y
    }
}

impl Add for Point<i32> {
    type Output = Self;

    fn add(self, other: Self) -> Self {
        Self {
            x: self.x + other.x,
            y: self.y + other.y,
        }
    }
}

impl Sub for Point<i32> {
    type Output = Self;

    fn sub(self, other: Self) -> Self {
        Self {
            x: self.x - other.x,
            y: self.y - other.y,
        }
    }
}