ReplayAlgorithm (MultiLayerAlignment)

All Known Implementing Classes:

AStar, AStar.Full, AStarLargeLP, AStarLargeLP.Full, Dijkstra, Dijkstra.Full, FullStatespaceBuilder
```
public interface ReplayAlgorithm
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ReplayAlgorithm.CloseResult

static class ReplayAlgorithm.Debug
Debug levels for the replayer.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ReplayAlgorithm.CloseResult`
`static class`	`ReplayAlgorithm.Debug` Debug levels for the replayer.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`addNewMarking(byte[] marking)` Adds a new marking to the internal storage.
`boolean`	`equalMarking(int markingId, byte[] marking)` Check for equality between the stored marking with ID markingId and an explicit marking.
`long`	`getEstimatedMemorySize()` Estimates the memory size of the internal data structures in bytes.
`int`	`getFScore(int markingId)` Returns the f score (i.e.
`int`	`getGScore(int markingId)` Returns the g score (i.e.
`int`	`getHScore(int marking)` Returns the h score (i.e.
`int`	`getIterationNumber()` Returns the current iteration number of the algorithm if there are multiple iterations in which the same marking IDs will be present.
`int`	`getLastRankOf(int markingId)` Returns the highest rank of an event explained by the path through which the stored marking with ID markingId was reached.
`byte[]`	`getMarking(int markingId)` Returns the explicit representation of the marking stored with ID markingId.
`SyncProduct`	`getNet()` Returns the synchronous product for which this ReplayAlgorithm was instantiated
`int`	`getPathLength(int marking)` returns the length of the path from the initial marking to reach this marking
`gnu.trove.map.TObjectIntMap<Utils.Statistic>`	`getStatistics()` Obtain the statistics after computing an alignment.
`boolean`	`hasExactHeuristic(int markingId)` Checks if the stored marking with ID markingId has an exact value for the heuristic function g.
`int`	`hashCode(byte[] marking)` Returns the hashCode for a marking represented explicitly as an array of bytes.
`int`	`hashCode(int markingId)` Returns the hashCode for the stored marking with ID markingId.
`boolean`	`isClosed(int markingId)` Checks if the stored marking with ID markingId is in the closed Set.
`boolean`	`isInfinite(int heur)` Checks if a value for the h-score is INFINITE.
`void`	`putStatistic(Utils.Statistic stat, int value)` Adds a statistic to the set of statistics.
`int[]`	`run(nl.tue.alignment.Canceler canceler, int timeoutMilliseconds, int maximumNumberOfStates, int costUpperLimit)` Run the replay algorithm.

- Method Detail
  - getNet
```
SyncProduct getNet()
```
    Returns the synchronous product for which this ReplayAlgorithm was instantiated
    
    Returns:
    
    the synchronous product
  - getIterationNumber
```
int getIterationNumber()
```
    Returns the current iteration number of the algorithm if there are multiple iterations in which the same marking IDs will be present. This method is needed for DOT output to separate the nodes in the iterations.
    
    Returns:
    
    the iteration number
  - getStatistics
```
gnu.trove.map.TObjectIntMap<Utils.Statistic> getStatistics()
```
    Obtain the statistics after computing an alignment. Should only be called after a call to run();
    
    Returns:
  - run
```
int[] run(nl.tue.alignment.Canceler canceler,
          int timeoutMilliseconds,
          int maximumNumberOfStates,
          int costUpperLimit)
   throws nl.tue.astar.util.ilp.LPMatrixException
```
    Run the replay algorithm. The canceler is provided for cancellation purposes. A timeout is specified in milliseconds and a maximum number of states is also provided. Furthermore, as cost upper limit can be given to bound the search.
    
    Parameters:
    
    canceler - Allows for canceling the computation
    
    timeoutMilliseconds - Timeout for the computation
    
    maximumNumberOfStates - Maximum number of states expanded
    
    costUpperLimit - Maximum cost of the alignment. Providing an upperbound of 0 will answer the yes/no question if the trace is fitting (assuming synchronous and tau-moves have cost 0)
    
    Returns:
    
    alignment as a sequence of transition firings from the initial marking to (1) the final marking if the computation is succesful or (2) any marking if it is not succesful
    
    Throws:
    
    nl.tue.astar.util.ilp.LPMatrixException - Exceptions is thrown if there is a problem with the LP computations.
  - putStatistic
```
void putStatistic(Utils.Statistic stat,
                  int value)
```
    Adds a statistic to the set of statistics. Can be called before or after run(), but the run() method may overwrite previously added statistics.
    
    Parameters:
    
    stat -
    
    value -
  - addNewMarking
```
int addNewMarking(byte[] marking)
```
    Adds a new marking to the internal storage. Method should only be called if it does not exist already.
    
    Parameters:
    
    marking - the byte[] indicating the number of tokens per place
    
    Returns:
    
    the id of the marking in the internal storage.
  - getMarking
```
byte[] getMarking(int markingId)
```
    Returns the explicit representation of the marking stored with ID markingId.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking())
    
    Returns:
    
    the explicit representation of the marking
  - hashCode
```
int hashCode(byte[] marking)
```
    Returns the hashCode for a marking represented explicitly as an array of bytes.
    
    Parameters:
    
    marking - the byte[] indicating the number of tokens per place
    
    Returns:
    
    a (non-cryptographic) hashcode for this marking
  - equalMarking
```
boolean equalMarking(int markingId,
                     byte[] marking)
```
    Check for equality between the stored marking with ID markingId and an explicit marking.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking())
    
    marking - the byte[] indicating the number of tokens per place
    
    Returns:
    
    a boolean indicating equality.
  - hashCode
```
int hashCode(int markingId)
```
    Returns the hashCode for the stored marking with ID markingId.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    a (non-cryptographic) hashcode for this marking
  - hasExactHeuristic
```
boolean hasExactHeuristic(int markingId)
```
    Checks if the stored marking with ID markingId has an exact value for the heuristic function g.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    true if the stored value for g is exact.
  - getLastRankOf
```
int getLastRankOf(int markingId)
```
    Returns the highest rank of an event explained by the path through which the stored marking with ID markingId was reached.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    the highest rank of any event explained by a path to this marking.
  - getFScore
```
int getFScore(int markingId)
```
    Returns the f score (i.e. the sum of the g and h score) for the stored marking with ID markingId .
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    The sum of g and h score.
  - getGScore
```
int getGScore(int markingId)
```
    Returns the g score (i.e. the minimal cost for reaching this marking so-far) for the stored marking with ID markingId .
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    The minimum cost through which this marking can be reached at this point.
  - getHScore
```
int getHScore(int marking)
```
    Returns the h score (i.e. an underestimate for the remaining cost to reach the final marking) for the stored marking with ID markingId .
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    The current underestimate for the remaining cost of reaching the final marking.
  - isInfinite
```
boolean isInfinite(int heur)
```
    Checks if a value for the h-score is INFINITE.
    
    Parameters:
    
    heur - a value for the h-score
    
    Returns:
    
    true if the provided value is considered INFINITE
  - isClosed
```
boolean isClosed(int markingId)
```
    Checks if the stored marking with ID markingId is in the closed Set.
    
    Parameters:
    
    markingId - an ID of a previously stored marking (ID obtained through addNewMarking()
    
    Returns:
    
    true if the marking is in the closed set.
  - getEstimatedMemorySize
```
long getEstimatedMemorySize()
```
    Estimates the memory size of the internal data structures in bytes.
    
    Returns:
    
    The estimated memory size of the internal data structures in bytes.
  - getPathLength
```
int getPathLength(int marking)
```
    returns the length of the path from the initial marking to reach this marking
    
    Parameters:
    
    marking -
    
    Returns:

Interface ReplayAlgorithm

Nested Class Summary

Method Summary

Method Detail

getNet

getIterationNumber

getStatistics

run

putStatistic

addNewMarking

getMarking

hashCode

equalMarking

hashCode

hasExactHeuristic

getLastRankOf

getFScore

getGScore

getHScore

isInfinite

isClosed

getEstimatedMemorySize

getPathLength