klotski/src/core/all_cases/all_cases.h

#pragma once

/// Based on the requirements of valid klotski, the 2x2 block that must exist
/// and only one, witch will occupy 4 empty slots, and the remaining 16 slots
/// will be allocated to 1x2, 2x1, 1x1 and space. Then, according to the rules
/// of CommonCode, they are coded as `00`, `01`, `10`, `11` respectively, and
/// the remaining positions are filled with 0 and stored as 32-bit variables.

/// As we all know, a space or 1x1 block will occupy 1 slot, 1x2 and 2x1 block
/// will occupy 2 slots, and together they fill 16 positions, so all possible
/// combinations can be calculated, this number is 204, each combination can
/// produce different permutations. After mathematical calculations, there are
/// a total of 7311921 possible permutations. The goal of BasicRanges is to
/// find these permutations, sort them and store in a uint32_t array.

/// AllCases is used to generate all valid CommonCodes, its works based on all
/// permutations generated by BasicRanges, which will use different 2x2 block
/// positions to check respectively. On the 5x4 chessboard, it has 12 possible
/// positions, and the numbers are distributed in 0 ~ 15, witch called `head`.
/// For the convenience of calculation, here use an array of length 16 for
/// storage, of course, the position of 3/7/11/15 will be empty.

///   00 01 02 03
///   04 05 06 07    00 01 02
///   08 09 10 11    04 05 06  <- head of 2x2 block
///   12 13 14 15    08 09 10
///   16 17 18 19    12 13 14

/// After all the work is done, we will have 29334498 cases, distributed in 16
/// arrays. Each of them is a uint32_t array storing the ranges, this is to
/// save memory, otherwise the 64-bit length must be consumed.

/// By the way, due to the performance considerations of the checking process,
/// the resulting data of BasicRanges will be flipped every 2-bit, which will
/// not consume too much time, but it can almost double the speed of the case
/// checking subsequent.

#include <mutex>
#include <vector>
#include <cstdint>

void demo();

namespace klotski {
namespace cases {

typedef uint32_t Range;
typedef std::vector<Range> Ranges;

const auto BASIC_RANGES_NUM = 7311921;

class BasicRanges {
public:
    void Build();
    const Ranges& Fetch() noexcept;
    bool IsAvailable() const noexcept;

    BasicRanges(BasicRanges&&) = delete;
    BasicRanges(const BasicRanges&) = delete;
    BasicRanges& operator=(BasicRanges&&) = delete;
    BasicRanges& operator=(const BasicRanges&) = delete;

    static BasicRanges& Instance() noexcept;

private:
    std::mutex building_;
    bool available_ = false;

    BasicRanges() = default;
    static Ranges& GetRanges() noexcept;
    static void BuildRanges(Ranges &ranges);
    static void SpawnRanges(Ranges&, int, int, int, int) noexcept;
};

} // namespace cases
} // namespace klotski