rubikscube

RubiksSubState.java

(1754B)

 /**
  * Holds part of the state of the rubik's cube with a heuristic that
  * measures the amount of moves away from the goal state.
  */
 public abstract class RubiksSubState {
 
     /* The state is the key of this RubiksSubState. */
     protected String state;
 
     /* The heuristic of this RubiksSubState. */
     protected byte heuristic = -1;
 
     /**
      * An RubiksSubState has a state as a key and a heuristic.
      * @param state the state
      * @param heuristic the heuristic (moves from the goal state).
      */
     protected RubiksSubState(String state, short heuristic) {
         this.state = state;
         this.heuristic = (byte) heuristic;
     }
 
     protected RubiksSubState(String state, int heuristic) {
         this(state, (short) heuristic);
     }
 
     protected RubiksSubState(String state) {
         this.state = state;
     }
 
     /**
      * Retrieve state.
      * @return The state of RubiksSubState.
      */
     public String getState() {
         return state;
     }
 
     /**
      * Retrieve heuristic.
      * @return The heuristic of RubiksSubState.
      */
     public byte getHeuristic() {
         return heuristic;
     }
 
     @Override
     public String toString() {
         return state;
     }
 
     /**
      * Simply a factorial function.
      * @param n Number
      * @return Factorial of n (n!)
      */
     protected static int fac(int n) {
         if(n<=1) return 1;
         return n * fac(n-1);
     }
 
     /**
      * Checks if the state is valid.
      * @param str The string to check.
      * @return If the state validates.
      */
     protected abstract boolean isValid(String str);
 
     /**
      * Hashes the state into a numerical value.
      * @return The hashed state.
      */
     protected abstract int hashState();
 }