org.processmining.models.semantics.petrinet.impl

Class EfficientPetrinetSemanticsImpl

java.lang.Object

org.processmining.models.semantics.petrinet.impl.EfficientPetrinetSemanticsImpl

All Implemented Interfaces:

java.io.Serializable, EfficientPetrinetSemantics, PetrinetSemantics, org.processmining.models.semantics.Semantics<Marking,Transition>

public final class EfficientPetrinetSemanticsImpl
extends java.lang.Object
implements EfficientPetrinetSemantics

More efficient implementation than PetrinetSemanticsImpl avoiding object creation.

Author:

F. Mannhardt, S.J. van Zelst

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.processmining.models.semantics.petrinet.EfficientPetrinetSemantics

EfficientPetrinetSemantics.PlaceVisitor

Constructor Summary

Constructors

Constructor and Description
EfficientPetrinetSemanticsImpl(EfficientPetrinetSemanticsImpl semantics) Creates a copy of the supplied semantics with an independent state.
EfficientPetrinetSemanticsImpl(PetrinetGraph net) Creates the semantics for the supplied PetrinetGraph and an empty initial marking.
EfficientPetrinetSemanticsImpl(PetrinetGraph net, Marking initialMarking) Creates the semantics for the supplied PetrinetGraph and initial Marking.

Method Summary

Modifier and Type	Method and Description
Marking	convert(byte[] marking) convert a primative int array to a marking object based on the internal index representation of the petri net's places.
byte[]	convert(Marking marking) allows to convert a given marking to an equivalent int array based on the internal index representation of the petri net's places.
void	directExecuteExecutableTransition(Transition transition) Executes (fires) a transition.
boolean	equalMarking(byte[] marking1, Marking marking2)
boolean	equalOrLessMarking(byte[] marking1, Marking marking2)
org.processmining.models.semantics.ExecutionInformation	executeExecutableTransition(Transition transition) For a more efficient implementation use directExecuteExecutableTransition(Transition), which does not return any information about the execution.
void	forEachMarkedPlace(EfficientPetrinetSemantics.PlaceVisitor placeVisitor) Visits each place that is marked with one or more tokens.
void	forEachPlace(EfficientPetrinetSemantics.PlaceVisitor placeVisitor) Visits each place.
Marking	getCurrentState() Convenience method of the original PetrinetSemantics interface.
java.util.Collection<Transition>	getExecutableTransitions() For better performance, use method EfficientPetrinetSemantics.isEnabled(Transition) instead.
int	getIndex(Place p)
int	getIndex(Transition t)
byte[]	getMissingTokensToEnable(int transitionIndex)
byte[]	getMissingTokensToEnable(Transition t) figures out whether a certain transition t is missing any tokens to be fired.
Place	getPlace(int index)
java.util.Map<Place,java.lang.Integer>	getPlaceMap()
byte[]	getState()
Marking	getStateAsMarking() Use getCurrentState() instead.
Transition	getTransition(int index)
void	initialize(java.util.Collection<Transition> transitions, Marking initialState) This method cannot be used in this implementation.
boolean	isEnabled(int transitionIndex)
boolean	isEnabled(Transition transition)
boolean	isMarked(byte[] marking, Place place)
void	setCurrentState(Marking marking) Convenience method of the original PetrinetSemantics interface.
void	setState(byte[] marking) Sets the state to the supplied state (marking).
void	setStateAsMarking(Marking marking) Use setCurrentState(Marking) instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EfficientPetrinetSemanticsImpl

public EfficientPetrinetSemanticsImpl(EfficientPetrinetSemanticsImpl semantics)

Creates a copy of the supplied semantics with an independent state. All other data structures are shared to minimize copying of data.

Parameters:

semantics -

EfficientPetrinetSemanticsImpl

public EfficientPetrinetSemanticsImpl(PetrinetGraph net)

Creates the semantics for the supplied PetrinetGraph and an empty initial marking. This semantics class treat all PetrinetGraphs as a Petrinet (so do not honor the semantics of reset or inhibitor nets).

Parameters:

net - with the graph structure

EfficientPetrinetSemanticsImpl

public EfficientPetrinetSemanticsImpl(PetrinetGraph net,
                                      Marking initialMarking)

Creates the semantics for the supplied PetrinetGraph and initial Marking. This semantics class treat all PetrinetGraphs as a Petrinet (so do not honor the semantics of reset or inhibitor nets).

Parameters:

net - with the graph structure

initialMarking -

Method Detail

getState

public byte[] getState()

Specified by:

getState in interface EfficientPetrinetSemantics

Returns:

a copy of the underlying array of tokens in the current state (marking).

setState

public void setState(byte[] marking)

Description copied from interface: EfficientPetrinetSemantics

Sets the state to the supplied state (marking). The state array is copied into the internal data structure.

Specified by:

setState in interface EfficientPetrinetSemantics

directExecuteExecutableTransition

public void directExecuteExecutableTransition(Transition transition)

Description copied from interface: EfficientPetrinetSemantics

Executes (fires) a transition. For performance reasons, this method does not check whether the transition is actually enabled and does not return information on what changed.

Specified by:

directExecuteExecutableTransition in interface EfficientPetrinetSemantics

isEnabled

public boolean isEnabled(Transition transition)

Specified by:

isEnabled in interface EfficientPetrinetSemantics

Returns:

whether the transition is enabled

isEnabled

public boolean isEnabled(int transitionIndex)

Specified by:

isEnabled in interface EfficientPetrinetSemantics

isMarked

public boolean isMarked(byte[] marking,
                        Place place)

Specified by:

isMarked in interface EfficientPetrinetSemantics

Parameters:

marking - obtained with EfficientPetrinetSemantics.getState()

place - of the net

Returns:

where place p is marked

forEachMarkedPlace

public void forEachMarkedPlace(EfficientPetrinetSemantics.PlaceVisitor placeVisitor)

Description copied from interface: EfficientPetrinetSemantics

Visits each place that is marked with one or more tokens.

Specified by:

forEachMarkedPlace in interface EfficientPetrinetSemantics

forEachPlace

public void forEachPlace(EfficientPetrinetSemantics.PlaceVisitor placeVisitor)

Description copied from interface: EfficientPetrinetSemantics

Visits each place.

Specified by:

forEachPlace in interface EfficientPetrinetSemantics

equalMarking

public boolean equalMarking(byte[] marking1,
                            Marking marking2)

Specified by:

equalMarking in interface EfficientPetrinetSemantics

Returns:

whether marking2 is equal to marking1

equalOrLessMarking

public boolean equalOrLessMarking(byte[] marking1,
                                  Marking marking2)

Specified by:

equalOrLessMarking in interface EfficientPetrinetSemantics

Returns:

whether marking2 has equal or less tokens on each place than marking1

setCurrentState

public void setCurrentState(Marking marking)

Convenience method of the original PetrinetSemantics interface. Use #setState(int[]) instead for a more efficient implementation.

Specified by:

setCurrentState in interface org.processmining.models.semantics.Semantics<Marking,Transition>

getCurrentState

public Marking getCurrentState()

Convenience method of the original PetrinetSemantics interface. Use getState() instead for a more efficient implementation.

Specified by:

getCurrentState in interface org.processmining.models.semantics.Semantics<Marking,Transition>

getExecutableTransitions

public java.util.Collection<Transition> getExecutableTransitions()

Description copied from interface: EfficientPetrinetSemantics

For better performance, use method EfficientPetrinetSemantics.isEnabled(Transition) instead.

Specified by:

getExecutableTransitions in interface EfficientPetrinetSemantics

Specified by:

getExecutableTransitions in interface org.processmining.models.semantics.Semantics<Marking,Transition>

Returns:

a collection of all enabled transitions

executeExecutableTransition

public org.processmining.models.semantics.ExecutionInformation executeExecutableTransition(Transition transition)
                                                                                    throws org.processmining.models.semantics.IllegalTransitionException

For a more efficient implementation use directExecuteExecutableTransition(Transition), which does not return any information about the execution.

Specified by:

executeExecutableTransition in interface EfficientPetrinetSemantics

Specified by:

executeExecutableTransition in interface org.processmining.models.semantics.Semantics<Marking,Transition>

Throws:

org.processmining.models.semantics.IllegalTransitionException

initialize

public void initialize(java.util.Collection<Transition> transitions,
                       Marking initialState)

This method cannot be used in this implementation. Please use the normal way to initialize an instance (the constructor).

Specified by:

initialize in interface org.processmining.models.semantics.Semantics<Marking,Transition>

getStateAsMarking

public Marking getStateAsMarking()

Use getCurrentState() instead.

Specified by:

getStateAsMarking in interface EfficientPetrinetSemantics

Returns:

the current state as a Marking

setStateAsMarking

public void setStateAsMarking(Marking marking)

Use setCurrentState(Marking) instead.

Specified by:

setStateAsMarking in interface EfficientPetrinetSemantics

getPlaceMap

public java.util.Map<Place,java.lang.Integer> getPlaceMap()

Returns:

a map from Place to its index in the marking returned by getState().

getIndex

public int getIndex(Transition t)

Specified by:

getIndex in interface EfficientPetrinetSemantics

Returns:

the index used (internally) for this transition.

getIndex

public int getIndex(Place p)

Specified by:

getIndex in interface EfficientPetrinetSemantics

Returns:

the index used for this place, corresponds to an index in EfficientPetrinetSemantics.getState()

getMissingTokensToEnable

public byte[] getMissingTokensToEnable(Transition t)

Description copied from interface: EfficientPetrinetSemantics

figures out whether a certain transition t is missing any tokens to be fired.

Specified by:

getMissingTokensToEnable in interface EfficientPetrinetSemantics

Parameters:

t - transition to fire

Returns:

array of the number of tokens missing for each indexed place to enable t

getPlace

public Place getPlace(int index)

Specified by:

getPlace in interface EfficientPetrinetSemantics

Parameters:

index - of the place

Returns:

the Place object corresponding to the index

getTransition

public Transition getTransition(int index)

Specified by:

getTransition in interface EfficientPetrinetSemantics

Parameters:

index - of the transition

Returns:

the Transition Object corresponding to the index

getMissingTokensToEnable

public byte[] getMissingTokensToEnable(int transitionIndex)

Specified by:

getMissingTokensToEnable in interface EfficientPetrinetSemantics

convert

public byte[] convert(Marking marking)

Description copied from interface: EfficientPetrinetSemantics

allows to convert a given marking to an equivalent int array based on the internal index representation of the petri net's places.

Specified by:

convert in interface EfficientPetrinetSemantics

Parameters:

marking - of the petri net used wihtin semantics

Returns:

corresponding int array

convert

public Marking convert(byte[] marking)

Description copied from interface: EfficientPetrinetSemantics

convert a primative int array to a marking object based on the internal index representation of the petri net's places.

Specified by:

convert in interface EfficientPetrinetSemantics

Parameters:

marking - to transform (int arr)

Returns:

fresh marking object