Browse Source
Add new ModelGenerator interface (will eventually replace ModelExplorer interface). Also add ModelInfo superclass containing just some syntactic model info and a default implementation of the class for easier use.
Add new ModelGenerator interface (will eventually replace ModelExplorer interface). Also add ModelInfo superclass containing just some syntactic model info and a default implementation of the class for easier use.
git-svn-id: https://www.prismmodelchecker.org/svn/prism/prism/trunk@10971 bbc10eb1-c90d-0410-af57-cb519fbb1720master
3 changed files with 379 additions and 0 deletions
-
162prism/src/prism/DefaultModelGenerator.java
-
158prism/src/prism/ModelGenerator.java
-
59prism/src/prism/ModelInfo.java
@ -0,0 +1,162 @@ |
|||
//============================================================================== |
|||
// |
|||
// Copyright (c) 2002- |
|||
// Authors: |
|||
// * Dave Parker <d.a.parker@cs.bham.ac.uk> (University of Birmingham/Oxford) |
|||
// * Nishan Kamaleson <nxk249@bham.ac.uk> (University of Birmingham) |
|||
// |
|||
//------------------------------------------------------------------------------ |
|||
// |
|||
// This file is part of PRISM. |
|||
// |
|||
// PRISM is free software; you can redistribute it and/or modify |
|||
// it under the terms of the GNU General Public License as published by |
|||
// the Free Software Foundation; either version 2 of the License, or |
|||
// (at your option) any later version. |
|||
// |
|||
// PRISM is distributed in the hope that it will be useful, |
|||
// but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
// GNU General Public License for more details. |
|||
// |
|||
// You should have received a copy of the GNU General Public License |
|||
// along with PRISM; if not, write to the Free Software Foundation, |
|||
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|||
// |
|||
//============================================================================== |
|||
|
|||
package prism; |
|||
|
|||
import java.util.ArrayList; |
|||
import java.util.List; |
|||
|
|||
import parser.State; |
|||
import parser.Values; |
|||
|
|||
/** |
|||
* Default implementation of the {@link ModelGenerator} interface |
|||
*/ |
|||
public abstract class DefaultModelGenerator implements ModelGenerator |
|||
{ |
|||
// Methods for ModelInfo interface |
|||
|
|||
@Override |
|||
public abstract ModelType getModelType(); |
|||
|
|||
@Override |
|||
public boolean containsUnboundedVariables() |
|||
{ |
|||
return false; |
|||
} |
|||
|
|||
@Override |
|||
public void setSomeUndefinedConstants(Values someValues) throws PrismException |
|||
{ |
|||
if (someValues != null && someValues.getNumValues() > 0) |
|||
throw new PrismException("This model has no constants to set"); |
|||
} |
|||
|
|||
@Override |
|||
public Values getConstantValues() |
|||
{ |
|||
// Empty values |
|||
return new Values(); |
|||
} |
|||
|
|||
@Override |
|||
public int getNumLabels() |
|||
{ |
|||
return 0; |
|||
} |
|||
|
|||
@Override |
|||
public String getLabelName(int i) throws PrismException |
|||
{ |
|||
throw new PrismException("Label number \"" + i + "\" not defined"); |
|||
} |
|||
|
|||
public int getLabelIndex(String label) |
|||
{ |
|||
return -1; |
|||
} |
|||
|
|||
// Methods for ModelGenerator interface |
|||
|
|||
public boolean hasSingleInitialState() throws PrismException |
|||
{ |
|||
// Default to the case of a single initial state |
|||
return true; |
|||
} |
|||
|
|||
@Override |
|||
public List<State> getInitialStates() throws PrismException |
|||
{ |
|||
// Default to the case of a single initial state |
|||
ArrayList<State> initStates = new ArrayList<State>(); |
|||
initStates.add(getInitialState()); |
|||
return initStates; |
|||
} |
|||
|
|||
@Override |
|||
public abstract State getInitialState() throws PrismException; |
|||
|
|||
@Override |
|||
public abstract void exploreState(State exploreState) throws PrismException; |
|||
|
|||
@Override |
|||
public abstract State getExploreState(); |
|||
|
|||
@Override |
|||
public abstract int getNumChoices() throws PrismException; |
|||
|
|||
@Override |
|||
public int getNumTransitions() throws PrismException |
|||
{ |
|||
// Default implementation |
|||
int tot = 0; |
|||
int n = getNumChoices(); |
|||
for (int i = 0; i < n; i++) { |
|||
tot += getNumTransitions(i); |
|||
} |
|||
return tot; |
|||
} |
|||
|
|||
@Override |
|||
public abstract int getNumTransitions(int i) throws PrismException; |
|||
|
|||
@Override |
|||
public abstract Object getTransitionAction(int i) throws PrismException; |
|||
|
|||
@Override |
|||
public abstract Object getTransitionAction(int i, int offset) throws PrismException; |
|||
|
|||
@Override |
|||
public abstract double getTransitionProbability(int i, int offset) throws PrismException; |
|||
|
|||
@Override |
|||
public abstract State computeTransitionTarget(int i, int offset) throws PrismException; |
|||
|
|||
@Override |
|||
public boolean isLabelTrue(String label) throws PrismException |
|||
{ |
|||
// Look up label and then check by index |
|||
int i = getLabelIndex(label); |
|||
if (i == -1) { |
|||
throw new PrismException("Label \"" + label + "\" not defined"); |
|||
} else { |
|||
return isLabelTrue(i); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public boolean isLabelTrue(int i) throws PrismException |
|||
{ |
|||
throw new PrismException("Label number \"" + i + "\" not defined"); |
|||
} |
|||
|
|||
@Override |
|||
public double getStateReward(int index, State state) throws PrismException |
|||
{ |
|||
return 0.0; |
|||
} |
|||
} |
|||
@ -0,0 +1,158 @@ |
|||
//============================================================================== |
|||
// |
|||
// Copyright (c) 2002- |
|||
// Authors: |
|||
// * Dave Parker <d.a.parker@cs.bham.ac.uk> (University of Birmingham/Oxford) |
|||
// * Nishan Kamaleson <nxk249@bham.ac.uk> (University of Birmingham) |
|||
// |
|||
//------------------------------------------------------------------------------ |
|||
// |
|||
// This file is part of PRISM. |
|||
// |
|||
// PRISM is free software; you can redistribute it and/or modify |
|||
// it under the terms of the GNU General Public License as published by |
|||
// the Free Software Foundation; either version 2 of the License, or |
|||
// (at your option) any later version. |
|||
// |
|||
// PRISM is distributed in the hope that it will be useful, |
|||
// but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
// GNU General Public License for more details. |
|||
// |
|||
// You should have received a copy of the GNU General Public License |
|||
// along with PRISM; if not, write to the Free Software Foundation, |
|||
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|||
// |
|||
//============================================================================== |
|||
|
|||
package prism; |
|||
|
|||
import java.util.List; |
|||
|
|||
import parser.State; |
|||
import parser.Values; |
|||
import parser.VarList; |
|||
|
|||
/** |
|||
* Interface for classes that generate a probabilistic model: |
|||
* given a particular model state (represented as a State object), |
|||
* they provide information about the outgoing transitions from that state. |
|||
*/ |
|||
public interface ModelGenerator extends ModelInfo |
|||
{ |
|||
/** |
|||
* Set values for *some* undefined constants. |
|||
* If there are no undefined constants, {@code someValues} can be null. |
|||
* Undefined constants can be subsequently redefined to different values with the same method. |
|||
* The current constant values (if set) are available via {@link #getConstantValues()}. |
|||
*/ |
|||
public void setSomeUndefinedConstants(Values someValues) throws PrismException; |
|||
|
|||
/** |
|||
* Get access to the values for all constants in the model, including the |
|||
* undefined constants set previously via the method {@link #setUndefinedConstants(Values)}. |
|||
* Until they are set for the first time, this method returns null. |
|||
*/ |
|||
public Values getConstantValues(); |
|||
|
|||
/** |
|||
* Does the model have a single initial state? |
|||
*/ |
|||
public boolean hasSingleInitialState() throws PrismException; |
|||
|
|||
/** |
|||
* Get the initial states of the model. |
|||
* The returned list should contain fresh State objects that can be kept/modified. |
|||
*/ |
|||
public List<State> getInitialStates() throws PrismException; |
|||
|
|||
/** |
|||
* Get the initial state of the model, if there is just one, |
|||
* or the first of the initial states if there are more than one. |
|||
* The returned State object should be fresh, i.e. can be kept/modified. |
|||
*/ |
|||
public State getInitialState() throws PrismException; |
|||
|
|||
/** |
|||
* Explore a given state of the model. After a call to this method, |
|||
* the class should be able to respond to the various methods that are |
|||
* available to query the outgoing transitions from the current state. |
|||
* @param exploreState State to explore (generate transition information for) |
|||
*/ |
|||
public void exploreState(State exploreState) throws PrismException; |
|||
|
|||
/** |
|||
* Get the state that is currently being explored, i.e. the last one for which |
|||
* {@link #exploreState(State)} was called. Can return null if there is no such state. |
|||
*/ |
|||
public State getExploreState(); |
|||
|
|||
/** |
|||
* Get the number of nondeterministic choices in the current state. |
|||
*/ |
|||
public int getNumChoices() throws PrismException; |
|||
|
|||
/** |
|||
* Get the total number of transitions in the current state. |
|||
*/ |
|||
public int getNumTransitions() throws PrismException; |
|||
|
|||
/** |
|||
* Get the number of transitions in the {@code i}th nondeterministic choice. |
|||
* @param i Index of the nondeterministic choice |
|||
*/ |
|||
public int getNumTransitions(int i) throws PrismException; |
|||
|
|||
/** |
|||
* Get the action label of a choice, specified by its index. |
|||
* The label can be any Object, but will often be treated as a string, so it should at least |
|||
* have a meaningful toString() method implemented. Absence of an action label is denoted by null. |
|||
* Note: If the model has different actions for different transitions within a choice |
|||
* (as can be the case for Markov chains), this method returns the action for the first transition. |
|||
*/ |
|||
public Object getTransitionAction(int i) throws PrismException; |
|||
|
|||
/** |
|||
* Get the action label of a transition within a choice, specified by its index/offset. |
|||
* The label can be any Object, but will often be treated as a string, so it should at least |
|||
* have a meaningful toString() method implemented. Absence of an action label is denoted by null. |
|||
* Note: For most types of models, the action label will be the same for all transitions within |
|||
* the same nondeterministic choice (i.e. for each different value of {@code offset}), |
|||
* but for Markov chains this may not necessarily be the case. |
|||
*/ |
|||
public Object getTransitionAction(int i, int offset) throws PrismException; |
|||
|
|||
/** |
|||
* Get the probability/rate of a transition within a choice, specified by its index/offset. |
|||
* @param i Index of the nondeterministic choice |
|||
* @param offset Index of the transition within the choice |
|||
*/ |
|||
public double getTransitionProbability(int i, int offset) throws PrismException; |
|||
|
|||
/** |
|||
* Get the target (as a new State object) of a transition within a choice, specified by its index/offset. |
|||
* @param i Index of the nondeterministic choice |
|||
* @param offset Index of the transition within the choice |
|||
*/ |
|||
public State computeTransitionTarget(int i, int offset) throws PrismException; |
|||
|
|||
/** |
|||
* Is label {@code label} true in the state currently being explored? |
|||
* @param label The name of the label to check |
|||
*/ |
|||
public boolean isLabelTrue(String label) throws PrismException; |
|||
|
|||
/** |
|||
* Is the {@code i}th label of the model true in the state currently being explored? |
|||
* @param i The index of the label to check |
|||
*/ |
|||
public boolean isLabelTrue(int i) throws PrismException; |
|||
|
|||
/** |
|||
* Get the state reward for state {@code state} using the reward structure with index {@code index}. |
|||
*/ |
|||
public double getStateReward(int index, State state) throws PrismException; |
|||
|
|||
// TODO: can we remove this? |
|||
public VarList createVarList(); |
|||
} |
|||
@ -0,0 +1,59 @@ |
|||
//============================================================================== |
|||
// |
|||
// Copyright (c) 2002- |
|||
// Authors: |
|||
// * Dave Parker <d.a.parker@cs.bham.ac.uk> (University of Birmingham/Oxford) |
|||
// * Nishan Kamaleson <nxk249@bham.ac.uk> (University of Birmingham) |
|||
// |
|||
//------------------------------------------------------------------------------ |
|||
// |
|||
// This file is part of PRISM. |
|||
// |
|||
// PRISM is free software; you can redistribute it and/or modify |
|||
// it under the terms of the GNU General Public License as published by |
|||
// the Free Software Foundation; either version 2 of the License, or |
|||
// (at your option) any later version. |
|||
// |
|||
// PRISM is distributed in the hope that it will be useful, |
|||
// but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
// GNU General Public License for more details. |
|||
// |
|||
// You should have received a copy of the GNU General Public License |
|||
// along with PRISM; if not, write to the Free Software Foundation, |
|||
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|||
// |
|||
//============================================================================== |
|||
|
|||
package prism; |
|||
|
|||
/** |
|||
* Interface for classes that provide some basic (syntactic) information about a probabilistic model. |
|||
*/ |
|||
public interface ModelInfo |
|||
{ |
|||
/** |
|||
* Get the type of probabilistic model. |
|||
*/ |
|||
public ModelType getModelType(); |
|||
|
|||
/** |
|||
* Does the model contain unbounded variables? |
|||
*/ |
|||
public boolean containsUnboundedVariables(); |
|||
|
|||
/** |
|||
* Get the number of labels (atomic propositions) defined for the model. |
|||
*/ |
|||
public int getNumLabels(); |
|||
|
|||
/** |
|||
* Get the name of the {@code i}th label of the model. |
|||
*/ |
|||
public String getLabelName(int i) throws PrismException; |
|||
|
|||
/** |
|||
* Get the index of the label with name {@code label}. Returns -1 if none exists. |
|||
*/ |
|||
public int getLabelIndex(String label); |
|||
} |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue