FCSFreecellAlgorithm.h

Go to the documentation of this file.

#ifndef FCS_FREECELL_ALGORITHM_H
#define FCS_FREECELL_ALGORITHM_H


#include "FCEnums.h"
#include "FCState.h"
#include "FCSDerivedStates.h"

/*
 * Conventions for use of the tests' order flags:
 * A test that should be scanned sequentially should have both flags cleared.
 * The first test in its random group should have both flags set. All the
 * other tests in the group should contain the FLAG_RANDOM flag.
 *
 * For instance: 123(45)(67)8 translates into:
 * 1 , 2, 3, 4|RANDOM|START_RANDOM_GROUP, 5|RANDOM, 
 * 6|RANDOM_START_RANDOM_GROUP, 7|RANDOM, 8
 *
 * */
enum FCS_TESTS_ORDER_FLAGS
{
    FCS_TEST_ORDER_NO_FLAGS_MASK = 0xFFFFFF,
    FCS_TEST_ORDER_FLAG_RANDOM = 0x1000000,
    FCS_TEST_ORDER_FLAG_START_RANDOM_GROUP = 0x2000000
};

class FCSFreecellAlgorithm
{
public:

    virtual FCSStateSolvingReturnCodes Solve(FCSStateWithLocations* StateWithLocations, int Depth) = 0;

    virtual FCSStateSolvingReturnCodes Resume(int Depth) = 0;

protected:
    void DeleteDerived(FCSDerivedStatesList* Derive);

    virtual FCSStateSolvingReturnCodes RunTest(int TestNumber, FCSStateWithLocations*  StateWithLocations,
                                                      int Depth, int NumberOfFreeStacks,
                                                      int NumberOfFreecells,
                                                      FCSDerivedStatesList* DerivedStateList) = 0;

};

#endif

---