slidy 0.3.2

Utilities for working with sliding puzzles
Documentation
//! Defines the [`AlgorithmSlice`] type.

use std::{
    fmt::Display,
    iter::{self, Sum},
};

use num_traits::{AsPrimitive, PrimInt};

use crate::{
    algorithm::{
        algorithm::Algorithm,
        direction::Direction,
        display::{
            algorithm::{AlgorithmDisplay as _, DisplaySpaced, DisplayUnspaced},
            r#move::{DisplayLongSpaced, DisplayLongUnspaced, DisplayShort},
        },
        metric::{Metric, Mtm, Stm},
        moves::Moves,
        r#move::r#move::{Move, MoveSum},
    },
    puzzle::size::Size,
};

/// A slice of an [`Algorithm`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct AlgorithmSlice<'a> {
    // We might slice in the middle of one move, e.g. D10LU10R[5..15] should be D5LU4. To represent
    // this, we need to store the first and last moves separately.
    pub(super) first: Option<Move>,
    pub(super) middle: &'a [Move],
    pub(super) last: Option<Move>,
}

impl AlgorithmSlice<'_> {
    /// The length of the slice in the [`Metric`] `M`.
    #[must_use]
    pub fn len<M: Metric, T: PrimInt + Sum + 'static>(&self) -> T
    where
        u64: AsPrimitive<T>,
    {
        self.moves().map(|m| M::len::<T>(m)).sum()
    }

    /// The length of the slice in the [`Stm`] [`Metric`].
    #[must_use]
    pub fn len_stm<T: PrimInt + Sum + 'static>(&self) -> T
    where
        u64: AsPrimitive<T>,
    {
        self.len::<Stm, T>()
    }

    /// The length of the slice in the [`Mtm`] [`Metric`].
    #[must_use]
    pub fn len_mtm<T: PrimInt + Sum + 'static>(&self) -> T
    where
        u64: AsPrimitive<T>,
    {
        self.len::<Mtm, T>()
    }

    /// Checks if the slice is empty.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.first.is_none() && self.middle.is_empty() && self.last.is_none()
    }

    /// Combines all consecutive moves along the same axis into a single move, and removes any moves
    /// that cancel completely. Returns the result as a new [`Algorithm`].
    #[must_use]
    pub fn simplified(&self) -> Algorithm {
        if self.moves().count() < 2 {
            return Algorithm::from(*self);
        }

        // List of simplified moves
        let mut moves = Vec::new();

        // Current move that we are accumulating into. This will be pushed to `moves` when we
        // reach a move that can't be added to it.
        let mut acc_move = None;

        for next in self.moves() {
            match acc_move {
                Some(sum) => match sum + next {
                    MoveSum::Ok(m) => {
                        // Moves completely cancel.
                        acc_move = if m.amount == 0 {
                            // Try and pop a move off `moves`, because the next move might cancel.
                            // e.g. consider URLD where `next` is the L move. We pop the U move
                            // from `moves` so that the following D move can cancel with it.
                            moves.pop()
                        }
                        // Moves can be added but don't fully cancel, keep accumulating into mv.
                        else {
                            Some(m)
                        };
                    }
                    // Moves can't be added, there is no more simplification at this point.
                    MoveSum::Invalid => {
                        // Push mv and go to the next move.
                        moves.push(sum);
                        acc_move = Some(next);
                    }
                },
                None => acc_move = Some(next),
            }
        }

        if let Some(m) = acc_move {
            if m.amount != 0 {
                moves.push(m);
            }
        }

        Algorithm::with_moves(moves)
    }

    /// Returns the result of reflecting the algorithm through the main diagonal as a new
    /// [`Algorithm`].
    #[must_use]
    pub fn transpose(&self) -> Algorithm {
        Algorithm::with_moves(self.moves().map(|m| m.transpose()).collect())
    }

    /// Concatenates `n` copies of `self` and returns the result as a new [`Algorithm`].
    #[must_use]
    pub fn repeat(&self, n: usize) -> Algorithm {
        let len = self.moves().len();
        Algorithm::with_moves(self.moves().cycle().take(len * n).collect::<Vec<_>>())
    }

    /// Returns `Some(size)` if `self` can be applied to a solved puzzle (with the gap in the
    /// bottom right) of size `size` but cannot be applied to any smaller solved puzzle. Returns
    /// `None` if `self` can not be applied to a puzzle of any size.
    #[must_use]
    pub fn min_applicable_size(&self) -> Option<Size> {
        // Gap position where (0, 0) is the bottom right position, increasing up and left
        let (mut max_gx, mut max_gy) = (0u64, 0u64);
        let (mut gx, mut gy) = (0u64, 0u64);

        for mv in self.moves() {
            let n = mv.amount;

            // Update the gap position occurs and return `None` if overflow/underflow occurs
            match mv.direction {
                Direction::Up => gy = gy.checked_sub(n)?,
                Direction::Left => gx = gx.checked_sub(n)?,
                Direction::Down => gy = gy.checked_add(n)?,
                Direction::Right => gx = gx.checked_add(n)?,
            }

            max_gx = max_gx.max(gx);
            max_gy = max_gy.max(gy);
        }

        Size::new(1 + max_gx, 1 + max_gy).ok()
    }

    /// An iterator over the single-tile moves in the slice.
    ///
    /// # Example
    ///
    /// ```
    /// # use std::str::FromStr as _;
    /// # use slidy::algorithm::{
    /// #     algorithm::Algorithm, as_slice::AsAlgorithmSlice, direction::Direction, r#move::r#move::Move,
    /// # };
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let alg = Algorithm::from_str("RD3LUR2")?;
    /// let slice = alg.as_slice();
    ///
    /// let mut iter = slice.single_tile_moves();
    /// assert_eq!(iter.next(), Some(Direction::Right));
    /// assert_eq!(iter.next(), Some(Direction::Down));
    /// assert_eq!(iter.next(), Some(Direction::Down));
    /// assert_eq!(iter.next(), Some(Direction::Down));
    /// assert_eq!(iter.next(), Some(Direction::Left));
    /// assert_eq!(iter.next(), Some(Direction::Up));
    /// assert_eq!(iter.next(), Some(Direction::Right));
    /// assert_eq!(iter.next(), Some(Direction::Right));
    /// assert_eq!(iter.next(), None);
    /// # Ok(())
    /// # }
    /// ```
    pub fn single_tile_moves(&self) -> impl Iterator<Item = Direction> + '_ {
        self.moves()
            .flat_map(|m| iter::repeat_n(m.direction, m.amount as usize))
    }

    /// An iterator over the multi-tile moves in the slice.
    ///
    /// # Example
    ///
    /// ```
    /// # use std::str::FromStr as _;
    /// # use slidy::algorithm::{
    /// #     algorithm::Algorithm, as_slice::AsAlgorithmSlice, direction::Direction, r#move::r#move::Move,
    /// # };
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let alg = Algorithm::from_str("RD3LUR2")?;
    /// let slice = alg.as_slice();
    ///
    /// let mut iter = slice.moves();
    /// assert_eq!(iter.next(), Some(Move::new(Direction::Right, 1)));
    /// assert_eq!(iter.next(), Some(Move::new(Direction::Down, 3)));
    /// assert_eq!(iter.next(), Some(Move::new(Direction::Left, 1)));
    /// assert_eq!(iter.next(), Some(Move::new(Direction::Up, 1)));
    /// assert_eq!(iter.next(), Some(Move::new(Direction::Right, 2)));
    /// assert_eq!(iter.next(), None);
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub fn moves(&self) -> Moves<'_> {
        Moves::new(*self)
    }

    /// Helper function for creating a [`DisplaySpaced<DisplayLongSpaced>`] around `self`.
    #[must_use]
    pub fn display_long_spaced(&self) -> DisplaySpaced<'_, DisplayLongSpaced> {
        DisplaySpaced::<DisplayLongSpaced>::new(self)
    }

    /// Helper function for creating a [`DisplayUnspaced<DisplayLongUnspaced>`] around `self`.
    #[must_use]
    pub fn display_long_unspaced(&self) -> DisplayUnspaced<'_, DisplayLongUnspaced> {
        DisplayUnspaced::<DisplayLongUnspaced>::new(self)
    }

    /// Helper function for creating a [`DisplaySpaced<DisplayShort>`] around `self`.
    #[must_use]
    pub fn display_short_spaced(&self) -> DisplaySpaced<'_, DisplayShort> {
        DisplaySpaced::<DisplayShort>::new(self)
    }

    /// Helper function for creating a [`DisplayUnspaced<DisplayShort>`] around `self`.
    #[must_use]
    pub fn display_short_unspaced(&self) -> DisplayUnspaced<'_, DisplayShort> {
        DisplayUnspaced::<DisplayShort>::new(self)
    }
}

impl Display for AlgorithmSlice<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        // Default formatting is short, unspaced.
        self.display_short_unspaced().fmt(f)
    }
}

#[cfg(test)]
mod tests {
    use std::str::FromStr as _;

    use crate::algorithm::as_slice::AsAlgorithmSlice as _;

    use super::*;

    #[test]
    fn test_len() -> Result<(), Box<dyn std::error::Error>> {
        let alg = Algorithm::from_str("R3D2LDR5U12RD3LU4R")?;

        for start in 0..34 {
            for end in start..34 {
                let slice = alg.try_slice(start..end)?;
                assert_eq!(slice.len_stm::<u64>(), end - start);
            }
        }

        Ok(())
    }

    #[test]
    fn test_is_empty() -> Result<(), Box<dyn std::error::Error>> {
        let alg = Algorithm::from_str("R3D2LDR5U12RD3LU4R")?;

        for start in 0..34 {
            for end in start..34 {
                let slice = alg.try_slice(start..end)?;
                assert_eq!(slice.is_empty(), (start..end).is_empty());
            }
        }

        Ok(())
    }

    #[test]
    fn test_min_applicable_size() {
        let size = |alg: &str| -> Option<Size> {
            Algorithm::from_str(alg)
                .unwrap()
                .as_slice()
                .min_applicable_size()
        };

        assert_eq!(size("DR"), Size::new(2, 2).ok());
        assert_eq!(size("D3RU2RD2RU3L3"), Size::new(4, 4).ok());
        assert_eq!(size("D10000"), Size::new(1, 10001).ok());
        assert_eq!(size("R10000"), Size::new(10001, 1).ok());
        assert_eq!(size("D9R9U9L9D8R8UL7U4R3D2L"), Size::new(10, 10).ok());
        assert_eq!(size("RDRDRDRDRDRDRDRDRD"), Size::new(10, 10).ok());
        assert_eq!(size("RDLD2R2U2RDL2U2LDRURDLUR2D2LU"), Size::new(4, 4).ok());

        assert_eq!(size("L"), None);
        assert_eq!(size("U"), None);
        assert_eq!(size("DRU2LDRD"), None);
        assert_eq!(size("R3DL4RURDLU"), None);
    }

    #[test]
    fn test_single_tile_moves() -> Result<(), Box<dyn std::error::Error>> {
        let alg = Algorithm::from_str("R3D2LDR5U12RD3LU4R")?;
        let slice = alg.try_slice(4..19)?;
        let mut moves = slice.single_tile_moves();

        assert_eq!(moves.next(), Some(Direction::Down));
        assert_eq!(moves.next(), Some(Direction::Left));
        assert_eq!(moves.next(), Some(Direction::Down));
        assert_eq!(moves.next(), Some(Direction::Right));
        assert_eq!(moves.next(), Some(Direction::Right));
        assert_eq!(moves.next(), Some(Direction::Right));
        assert_eq!(moves.next(), Some(Direction::Right));
        assert_eq!(moves.next(), Some(Direction::Right));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), Some(Direction::Up));
        assert_eq!(moves.next(), None);
        assert_eq!(moves.next(), None);

        Ok(())
    }
}