HeapConfiguration (Attestor 0.4.1 API)

All Known Implementing Classes:

HeapConfigurationPair, InternalHeapConfiguration
```
public interface HeapConfiguration
```
A HeapConfiguration is a hypergraph in which each node corresponds to a location on the heap of a program, such as null or a reference to some object. Nodes are assigned a Type which determines the class of the object represented by a node. Nodes are accessed through integer values.
There are three possible kinds of hyperedges:
1. Selector edges connect exactly two nodes and represent a pointer from the source node to the target point. Selector edges are labeled with a SelectorLabel. If a node represents an object of a certain class then a selector edge can be thought of as a variable of that object that references another object. Consequently, the SelectorLabel corresponds to the name of the variable. For each node and each SelectorLabel, there is at most one selector edge having this node as a source node with that SelectorLabel. Selector edges are accessed through their source node and their SelectorLabel.
2. Nonterminal edges connect an arbitrary number of nodes and represent abstract heap shapes, such as linked lists, trees etc. Nonterminal edges are labeled with a Nonterminal that determines the number of nodes connected to it and what is actually modeled by a nonterminal edge. Nonterminal edges are accessed through integer values.
3. Variables edges model a program variable and are attached to exactly one node. They are labeled with a Variable. Variable edges are accessed through integer values.
HeapConfigurations can be treated as immutable objects as long as they are not marked as mutable explicitly by calling builder().
Author:

Christoph

Field Summary

Fields
Modifier and Type Field and Description

static int INVALID_ELEMENT
Value representing an element that does not belong to any HeapConfiguration.

Fields
Modifier and Type	Field and Description
`static int`	`INVALID_ELEMENT` Value representing an element that does not belong to any HeapConfiguration.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`gnu.trove.list.array.TIntArrayList`	`attachedNodesOf(int ntEdge)`
`gnu.trove.list.array.TIntArrayList`	`attachedNonterminalEdgesOf(int node)`
`gnu.trove.map.TIntIntMap`	`attachedNonterminalEdgesWithNonReductionTentacle(int node)`
`gnu.trove.list.array.TIntArrayList`	`attachedVariablesOf(int node)`
`HeapConfigurationBuilder`	`builder()` Mark a HeapConfiguration as temporarily mutable by a `HeapConfigurationBuilder`.
`HeapConfiguration`	`clone()`
`int`	`countExternalNodes()`
`int`	`countNodes()`
`int`	`countNonterminalEdges()`
`int`	`countVariableEdges()`
`int`	`externalIndexOf(int node)`
`int`	`externalNodeAt(int pos)`
`gnu.trove.list.array.TIntArrayList`	`externalNodes()`
`AbstractMatchingChecker`	`getEmbeddingsOf(HeapConfiguration pattern, MorphismOptions options)` Returns an AbstractMatchingChecker to search for all occurrences of the given pattern HeapConfiguration in this HeapConfiguration (the target).
`HeapConfiguration`	`getEmpty()`
`boolean`	`isExternalNode(int node)`
`Nonterminal`	`labelOf(int ntEdge)`
`String`	`nameOf(int varEdge)`
`gnu.trove.list.array.TIntArrayList`	`nodes()`
`Type`	`nodeTypeOf(int node)`
`gnu.trove.list.array.TIntArrayList`	`nonterminalEdges()`
`gnu.trove.list.array.TIntArrayList`	`predecessorNodesOf(int node)`
`int`	`rankOf(int ntEdge)`
`List<SelectorLabel>`	`selectorLabelsOf(int node)`
`int`	`selectorTargetOf(int node, SelectorLabel sel)`
`gnu.trove.list.array.TIntArrayList`	`successorNodesOf(int node)`
`int`	`targetOf(int varEdge)`
`gnu.trove.list.array.TIntArrayList`	`variableEdges()`
`int`	`variableTargetOf(String variableName)`
`int`	`variableWith(String name)`

- Field Detail
  - INVALID_ELEMENT
```
static final int INVALID_ELEMENT
```
    Value representing an element that does not belong to any HeapConfiguration.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - clone
```
HeapConfiguration clone()
```
    Returns:
    
    A deep copy of this HeapConfiguration.
  - getEmpty
```
HeapConfiguration getEmpty()
```
    Returns:
    
    An empty heap configuration
  - builder
```
HeapConfigurationBuilder builder()
```
    Mark a HeapConfiguration as temporarily mutable by a HeapConfigurationBuilder. The HeapConfiguration stays mutable until HeapConfigurationBuilder.build() is called. For each HeapConfiguration, there is either no builder (immutable) or exactly one builder (mutable).
    
    Returns:
    
    The HeapConfigurationBuilder that allows mutation of this HeapConfiguration.
  - countNodes
```
int countNodes()
```
    Returns:
    
    The number of nodes contained in the HeapConfiguration.
  - nodes
```
gnu.trove.list.array.TIntArrayList nodes()
```
    Returns:
    
    A list of all nodes contained in the heap contained in the HeapConfiguration.
  - nodeTypeOf
```
Type nodeTypeOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    The type of the given node.
  - attachedVariablesOf
```
gnu.trove.list.array.TIntArrayList attachedVariablesOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    A list of all variables attached to the given node.
  - attachedNonterminalEdgesOf
```
gnu.trove.list.array.TIntArrayList attachedNonterminalEdgesOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    A list of all nonterminal edges attached to the given node.
  - successorNodesOf
```
gnu.trove.list.array.TIntArrayList successorNodesOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    A list of all nodes reachable by a single selector edge from the given node.
  - predecessorNodesOf
```
gnu.trove.list.array.TIntArrayList predecessorNodesOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    A list of all nodes that can reach the given node by a single selector.
  - selectorLabelsOf
```
List<SelectorLabel> selectorLabelsOf(int node)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    Returns:
    
    A list of all selectors that occur as edge labels for the given node.
  - selectorTargetOf
```
int selectorTargetOf(int node,
                     SelectorLabel sel)
```
    Parameters:
    
    node - A node contained in the HeapConfiguration.
    
    sel - A SelectorLabel that occurs as an edge label for the given node.
    
    Returns:
    
    The node reached by taken the given selector from the given node.
  - countExternalNodes
```
int countExternalNodes()
```
    Returns:
    
    The number of external nodes in this HeapConfiguration.
  - externalNodes
```
gnu.trove.list.array.TIntArrayList externalNodes()
```
    Returns:
    
    A list of all external nodes in this HeapConfiguration.
  - externalNodeAt
```
int externalNodeAt(int pos)
```
    Parameters:
    
    pos - An index of an external node satisfying 0 <= pos && pos <= countExternalNodes().
    
    Returns:
    
    The requested external node.
  - isExternalNode
```
boolean isExternalNode(int node)
```
    Parameters:
    
    node - A node in the HeapConfiguration.
    
    Returns:
    
    true if and only if the given node is external.
  - externalIndexOf
```
int externalIndexOf(int node)
```
    Parameters:
    
    node - A node in the HeapConfiguration.
    
    Returns:
    
    The position of the given node in the sequence of external nodes.
  - countNonterminalEdges
```
int countNonterminalEdges()
```
    Returns:
    
    The number of nonterminal edges in this HeapConfiguration.
  - nonterminalEdges
```
gnu.trove.list.array.TIntArrayList nonterminalEdges()
```
    Returns:
    
    A list of all nonterminal edges in this HeapConfiguration.
  - rankOf
```
int rankOf(int ntEdge)
```
    Parameters:
    
    ntEdge - A nonterminal edge in this HeapConfiguration.
    
    Returns:
    
    The number of nodes attached to the given nonterminal edge.
  - labelOf
```
Nonterminal labelOf(int ntEdge)
```
    Parameters:
    
    ntEdge - A nonterminal edge in this HeapConfiguration.
    
    Returns:
    
    The label of the given nonterminal edge.
  - attachedNodesOf
```
gnu.trove.list.array.TIntArrayList attachedNodesOf(int ntEdge)
```
    Parameters:
    
    ntEdge - A nonterminal edge in this HeapConfiguration.
    
    Returns:
    
    The list of nodes attached to the given nonterminal edge.
  - countVariableEdges
```
int countVariableEdges()
```
    Returns:
    
    The number of variable edges in this HeapConfiguration.
  - variableEdges
```
gnu.trove.list.array.TIntArrayList variableEdges()
```
    Returns:
    
    A list of all variable edges contained in this HeapConfiguration.
  - variableWith
```
int variableWith(String name)
```
    Parameters:
    
    name - The name of the requested variable
    
    Returns:
    
    The variable with the requested name or INVALID_ELEMENT.
  - nameOf
```
String nameOf(int varEdge)
```
    Parameters:
    
    varEdge - A variable edge in this HeapConfiguration.
    
    Returns:
    
    The name of the given variable edge.
  - targetOf
```
int targetOf(int varEdge)
```
    Parameters:
    
    varEdge - A variable edge in this HeapConfiguration.
    
    Returns:
    
    The node attached to the given variable edge.
  - getEmbeddingsOf
```
AbstractMatchingChecker getEmbeddingsOf(HeapConfiguration pattern,
                                        MorphismOptions options)
```
    Returns an AbstractMatchingChecker to search for all occurrences of the given pattern HeapConfiguration in this HeapConfiguration (the target).
    
    Parameters:
    
    pattern - The HeapConfiguration to search for.
    
    options - Options guiding how embeddings are computed.
    
    Returns:
    
    An AbstractMatchingChecker to iterate through all found embeddings.
  - variableTargetOf
```
int variableTargetOf(String variableName)
```
    Parameters:
    
    variableName - The name of the requested variable.
    
    Returns:
    
    The unique node attached to a variable edge with the given name or INVALID_ELEMENT if no such variable edge exists.
  - attachedNonterminalEdgesWithNonReductionTentacle
```
gnu.trove.map.TIntIntMap attachedNonterminalEdgesWithNonReductionTentacle(int node)
```
    Parameters:
    
    node - A node in the graph.
    
    Returns:
    
    Mapping from attached nonterminal edges to node to the index of the first non reduction tentacle attached to node.

Interface HeapConfiguration

Field Summary

Method Summary

Field Detail

INVALID_ELEMENT

Method Detail

clone

getEmpty

builder

countNodes

nodes

nodeTypeOf

attachedVariablesOf

attachedNonterminalEdgesOf

successorNodesOf

predecessorNodesOf

selectorLabelsOf

selectorTargetOf

countExternalNodes

externalNodes

externalNodeAt

isExternalNode

externalIndexOf

countNonterminalEdges

nonterminalEdges

rankOf

labelOf

attachedNodesOf

countVariableEdges

variableEdges

variableWith

nameOf

targetOf

getEmbeddingsOf

variableTargetOf

attachedNonterminalEdgesWithNonReductionTentacle