FCSFreecellData.h

Go to the documentation of this file.

#ifndef FCS_FREECELL_DATA_H
#define FCS_FREECELL_DATA_H


#include <limits.h> //needed for INT_MAX
#include "FCState.h"
#include "FCSMove.h"
#include "FCSDerivedStates.h"
#include "FCCommandLineArguments.h"
#include "FCSStateStorage.h"
#include "FCSStackStorage.h"
//*** These won't be necessary if the compare/hash algorithms are moved
#include "FCSIndirectStateCompareAlgorithm.h"
#include "HashAlgorithms.h"

class FCSIndirectCard;

template <class SolvingAlgorithm>
class FCSOptimizeSolvingAlgorithm;

class FCSFreecellSolvingAlgorithm;
class FCSSimpleSimonSolvingAlgorithm;
class FCSTalonSolvingAlgorithm;

class FCSFreecellData
{
public:
    virtual ~FCSFreecellData();

    int GetNumberOfCheckedStates();

    int GetNumberOfStatesInCollection();

    void IncreaseMaxNumberOfCheckedStates();

    void CleanData();

    virtual void ShowSolution(FCSStateWithLocations* InitStateWithLocations, FCSStateWithLocations* DupStateWithLocations);

    void TraceSolution();

    friend class FCSOptimizeSolvingAlgorithm<FCSFreecellSolvingAlgorithm>;
    friend class FCSOptimizeSolvingAlgorithm<FCSSimpleSimonSolvingAlgorithm>;
    friend class FCSOptimizeSolvingAlgorithm<FCSTalonSolvingAlgorithm>;

protected:
    FCSFreecellData();
    void InitFCSFreecellData();
    FCSFreecellData(FCCommandLineArguments* CommandLine);

    void InitSolve(FCSStateWithLocations* InitState);
    
    int GetNextMove(FCSStateWithLocations* StateWithLocations, FCSMove* Move);

    bool IsOptimizeClass;

    FCStateType m_StateType;

    AFCSStateWithLocationsMatrix* m_StatePacks;

    int m_MaxNumberOfStatePacks;

    int m_NumberOfStatePacks;
    
    int m_NumberOfStatesInLastPack;
    
    int m_StatePackLength;

    int m_NumberOfCheckedStates;

    int m_NumberOfStatesInCollection;

    int m_MaxNumberOfStatesInCollection;

    AFCSStateWithLocationsMatrix* m_SolutionStates;

    int m_NumberOfSolutionStates;

    FCSMoveStack* m_SolutionMoves;

    FCSMoveStack** m_ProtoSolutionMoves;

    FCSStateWithLocations* m_FinalState;

    int m_MaxDepth;

    int m_MaxNumberOfCheckedStates;

    FCSDebugDisplayInfo* m_DebugDisplayInfo;

    int m_TestsOrder[FCS_TESTS_NUM];

    int m_TestsOrderNumber;

    AFCSGenericStateStorage* m_StateStorage;

    AFCSGenericStackStorage* m_StackStorage;

    int m_NumberOfFreecells;
    
    int m_NumberOfStacks;

    int m_NumberOfDecks;

    BuildSequenceByEnum m_SequencesAreBuiltBy;

    bool m_IsUnlimitedSequenceMove;

    FCEmptyStacksFillType m_EmptyStacksFill;

    bool m_OptimizeSolutionPath;

    //****** I'm not quite sure where to put these, so they're here for now *****
    //****** Since they vary, should they all be pointers and allocated only if needed ?  *****
    CompareFunctionCompareNodesAlgorithm<FCSStateWithLocations, void> m_CompareFunction;
    MD5StateWithLocationsHashAlgorithm m_MD5Hash;
    FCSIndirectCardCompareAlgorithm<FCSIndirectCard, void>* m_IndirectCompare;
    MD5HashAlgorithm<FCSIndirectCard>* m_IndirectHash;

    FCSStateWithLocations* StatePackAlloc();

    void StatePackRelease();

    virtual FCSStateSolvingReturnCodes CheckAndAddState(FCSStateWithLocations* NewState,
                         FCSStateWithLocations** ExistingState,
                         int Depth);

    virtual inline void CheckStateBegin(FCSStateWithLocations** NewStateWithLocations, FCSStateWithLocations* StateWithLocations,
                                        FCSMoveStack *Move);

    virtual inline bool CheckStateEnd(FCSStateWithLocations** NewStateWithLocations, FCSStateWithLocations* StateWithLocations, 
                                        FCSDerivedStatesList** DerivedStateList, FCSMoveStack** Move, FCSMove** TempMove, int Depth, 
                                        FCSStateSolvingReturnCodes* ReturnCode);

    void CreateTotalMovesStack();

    bool IsParentCard(FCSCard* Child, FCSCard* Parent);

    int CalculateMaxSequenceMoves(int FreecellNumber, int FreeStackNumber);

    void MoveSequence(FCSStateWithLocations* NewStateWithLocations, FCSCard* Card, FCSMoveStack *MoveStack, FCSMove** TempMove, 
                    int DestStack, int SourceStack, int Start, int End);

};

#endif

---