min2phase.h

#ifndef MIN2PHASE
#define MIN2PHASE 1

#include <cstdint>
#include <string>

namespace min2phase{

    /**
     * This is used to indicate if use a dot from the moves
     * used in phase 1 and 2.
     */
    const int8_t USE_SEPARATOR = 0x1;

    /**
     * This is used to find a scramble that generate the input cube from the
     * solved cube instead of generate a scramble that solve the cube.
     */
    const int8_t INVERSE_SOLUTION = 0x2;

    /**
     * This is used to add the number of moves used at the end of
     * the string.
     */
    const int8_t APPEND_LENGTH = 0x4;

    /**
     *  Determines if guaranteeing the solution to be optimal.
     */
    const int8_t OPTIMAL_SOLUTION = 0x8;

    /**
     * This function compute all the variable necessary for te algorithm.
     */
    void init();

    /**
     * This is used to solve the cube. It has many configuration in base of the
     * power of the machine or the memory. Less the max depth is, more the time
     * to solve the cube is used, is suggested to use from 20 to 31 because it
     * indicates the max number of moves are used to solve the cube. The probe
     * indicate the number of cube that the algorithm is forced to explore.
     * If you need speed i suggest 0 for the probeMin and 100000000 for the max.
     * You can also change the formatting string in output adding it at verbose,
     * for example OutputFormat::USE_SEPARATOR | OutputFormat::INVERSE_SOLUTION.
     * This the order of the colors for the string:
     * U1 -> U9 R1 -> R9 F1 -> F9 D1 -> D9 L1 -> L9 B1 -> B9
     * Solved cube: UUUUUUUUURRRRRRRRRFFFFFFFFFDDDDDDDDDLLLLLLLLLBBBBBBBBB
     *
     *             |************|
     *             |*U1**U2**U3*|
     *             |************|
     *             |*U4**U5**U6*|
     *             |************|
     *             |*U7**U8**U9*|
     *             |************|
     * ************|************|************|************|
     * *L1**L2**L3*|*F1**F2**F3*|*R1**R2**R3*|*B1**B2**B3*|
     * ************|************|************|************|
     * *L4**L5**L6*|*F4**F5**F6*|*R4**R5**R6*|*B4**B5**B6*|
     * ************|************|************|************|
     * *L7**L8**L9*|*F7**F8**F9*|*R7**R8**R9*|*B7**B8**B9*|
     * ************|************|************|************|
     *             |************|
     *             |*D1**D2**D3*|
     *             |************|
     *             |*D4**D5**D6*|
     *             |************|
     *             |*D7**D8**D9*|
     *             |************|
     *
     * @param facelet  : the order of colors like the cube above.
     * @param maxDepth : the max of moves used to solve the cube, from 20 to 31.
     * @param probeMax : the max of cube explored in phase 2.
     * @param probeMin : the min of cube explored in phase 2.
     * @param verbose  : the format for the output strings.
     * @param usedMoves: the pointer to store the number of moves used.
     * @return         : the moved necessary to solve the cube. Delete the return value when
     *                   you don't need it anymore.
     */
    std::string solve(const std::string& facelets, int8_t maxDepth, int32_t probeMax, int32_t probeMin, int8_t verbose, uint8_t* usedMoves = nullptr);
}

#endif //MIN2PHASE