org.ggp.base.util.statemachine.CachedStateMachine Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of alloy-ggp-base Show documentation
A modified version of the GGP-Base library for Alloy.
There is a newer version: 0.0.15
package org.ggp.base.util.statemachine;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.ggp.base.util.gdl.grammar.Gdl;
import org.ggp.base.util.gdl.grammar.GdlConstant;
import org.ggp.base.util.gdl.grammar.GdlSentence;
import org.ggp.base.util.gdl.grammar.GdlTerm;
import org.ggp.base.util.propnet.architecture.Component;
import org.ggp.base.util.propnet.architecture.PropNet;
import org.ggp.base.util.statemachine.cache.TtlCache;
import org.ggp.base.util.statemachine.exceptions.GoalDefinitionException;
import org.ggp.base.util.statemachine.exceptions.MoveDefinitionException;
import org.ggp.base.util.statemachine.exceptions.TransitionDefinitionException;

//TODO: This looks terribly unsynchronized...
public class CachedStateMachine extends StateMachine {

    private final class Entry
    {
        public Map goals;
        public Map> moves;
        public Map, MachineState> nexts;
        public Boolean terminal;
        public Map gebMoves;

        public Entry()
        {
            goals = new HashMap();
            moves = new HashMap>();
            nexts = new HashMap, MachineState>();
            terminal = null;
            gebMoves = null;
        }
    }

    private final TtlCache ttlCache;

    StateMachine internalStateMachine;
    public CachedStateMachine(StateMachine sm)
    {
        internalStateMachine = sm;
        ttlCache = new TtlCache(1);
    }
    private CachedStateMachine(StateMachine sm, TtlCache cache) {
        internalStateMachine = sm;
        ttlCache = cache;
    }

    private Entry getEntry(MachineState state)
    {
        if (!ttlCache.containsKey(state))
        {
            ttlCache.put(state, new Entry());
        }

        return ttlCache.get(state);
    }

    @Override
    public int getGoal(MachineState state, Role role) throws GoalDefinitionException
    {
        Entry entry = getEntry(state);
        synchronized (entry)
        {
            if (!entry.goals.containsKey(role))
            {
                entry.goals.put(role, internalStateMachine.getGoal(state, role));
            }

            return entry.goals.get(role);
        }
    }

    @Override
    public List getLegalMoves(MachineState state, Role role) throws MoveDefinitionException
    {
        Entry entry = getEntry(state);
        synchronized (entry)
        {
            if (!entry.moves.containsKey(role))
            {
                entry.moves.put(role, internalStateMachine.getLegalMoves(state, role));
            }

            return entry.moves.get(role);
        }
    }

    @Override
    public MachineState getNextState(MachineState state, List moves) throws TransitionDefinitionException
    {
        Entry entry = getEntry(state);
        //It has gotten a NullPointerException here...
        synchronized (entry)
        {
            if (!entry.nexts.containsKey(moves))
            {
                entry.nexts.put(moves, internalStateMachine.getNextState(state, moves));
            }

            return entry.nexts.get(moves);
        }
    }

    @Override
    public boolean isTerminal(MachineState state)
    {
        Entry entry = getEntry(state);
        if(entry == null)
            throw new RuntimeException("How did we get a null entry? Check cache");
        synchronized (entry)
        {
            if (entry.terminal == null)
            {
                entry.terminal = internalStateMachine.isTerminal(state);
            }

            return entry.terminal;
        }
    }

    @Override
    public Map getGebMoves(MachineState state) {
        Entry entry = getEntry(state);
        synchronized (entry)
        {
            if (entry.gebMoves == null)
            {
                entry.gebMoves = internalStateMachine.getGebMoves(state);
            }

            return entry.gebMoves;
        }
    }

    @Override
    public void doPerMoveWork()
    {
        prune();
    }

    public void prune()
    {
        ttlCache.prune();
    }

    @Override
    public MachineState getInitialState() {
        return internalStateMachine.getInitialState();
    }

    @Override
    public MachineState getMachineStateFromSentenceList(Set sentenceList) {
        return internalStateMachine.getMachineStateFromSentenceList(sentenceList);
    }

    @Override
    public Move getMoveFromTerm(GdlTerm term) {
        return internalStateMachine.getMoveFromTerm(term);
    }

    @Override
    public Role getRoleFromConstant(GdlConstant constant) {
        return internalStateMachine.getRoleFromConstant(constant);
    }

    @Override
    public List getRoles() {
        return internalStateMachine.getRoles();
    }

    @Override
    public StateMachine getSynchronizedCopy() {
        //We want the caches to be linked...
        //This constructor causes the state machines to share their cache
        return new CachedStateMachine(internalStateMachine.getSynchronizedCopy(), ttlCache);
    }

    @Override
    public void initialize(List description) {
        internalStateMachine.initialize(description);
    }

    @Override
    public MachineState translateState(MachineState state) {
        return internalStateMachine.translateState(state);
    }
    @Override
    public boolean isNative(MachineState state) {
        return internalStateMachine.isNative(state);
    }
    @Override
    public boolean isPropNetBased() {
        return internalStateMachine.isPropNetBased();
    }
    @Override
    public PropNet getPropNet() {
        return internalStateMachine.getPropNet();
    }
    @Override
    public boolean getComponentValue(MachineState state, Component component) {
        return internalStateMachine.getComponentValue(state, component);
    }
    @Override
    public int getComponentTrueInputsCount(MachineState state,
            Component component) {
        return internalStateMachine.getComponentTrueInputsCount(state, component);
    }

}