de.rwth.i2.attestor.graph.heap

Interface HeapConfigurationBuilder

All Known Implementing Classes:

HeapConfigurationPairBuilder, InternalHeapConfigurationBuilder

public interface HeapConfigurationBuilder

A HeapConfigurationBuilder allows to mutate a given HeapConfiguration. Hence, as long as a HeapConfigurationBuilder exists for a HeapConfiguration, the HeapConfiguration is mutable. It is set to an immutable HeapConfiguration again by calling build().

There is always at most one HeapConfigurationBuilder for each HeapConfiguration.

Author:

Christoph

Method Summary

Modifier and Type	Method and Description
HeapConfigurationBuilder	addNodes(Type type, int count, gnu.trove.list.array.TIntArrayList buffer) Add count nodes of Type type to the underlying graph.
NonterminalEdgeBuilder	addNonterminalEdge(Nonterminal nt) gets a nonterminalEdgeBuilder that allows to specify the tentacles of this nonterminal and add the resulting edge to the graph
HeapConfigurationBuilder	addNonterminalEdge(Nonterminal label, gnu.trove.list.array.TIntArrayList attachedNodes) Adds a new nonterminal edge.
int	addNonterminalEdgeAndReturnId(Nonterminal label, gnu.trove.list.array.TIntArrayList attachedNodes) Adds a new nonterminal edge and returns the respective id
HeapConfigurationBuilder	addSelector(int from, SelectorLabel sel, int to) Adds a new selector edge that is labeled with 'sel' and points from node 'from' to node 'to'.
HeapConfigurationBuilder	addVariableEdge(String name, int target) Adds a new, not already existing, variable edge and attaches it to the given target node.
HeapConfiguration	build() Marks the underlying HeapConfiguration as immutable again (until a new builder is requested).
HeapConfigurationBuilder	mergeExternals(gnu.trove.list.array.TIntArrayList extIndicesMap) Merges external nodes according to the provided index map.
HeapConfigurationBuilder	removeIsolatedNode(int node) Removes an isolated node from the underlying HeapConfiguration
HeapConfigurationBuilder	removeNode(int node) Removes the given node from the underlying HeapConfiguration.
HeapConfigurationBuilder	removeNonterminalEdge(int ntEdge) Removes a given nonterminal edge.
HeapConfigurationBuilder	removeSelector(int node, SelectorLabel sel) Removes an outgoing selector edge with the provided label 'sel' from the node 'node'.
HeapConfigurationBuilder	removeVariableEdge(int varEdge) Removes the provided variable edge.
HeapConfigurationBuilder	replaceMatching(Matching matching, Nonterminal nonterminal) Replaces the graph captured by the provided matching by a fresh nonterminal edge labeled with the provided nonterminal.
HeapConfigurationBuilder	replaceMatchingWithCollapsedExternals(Matching matching, Nonterminal nonterminal, gnu.trove.list.array.TIntArrayList externalIndicesMap) Replaces the graph captured by the provided matching by a fresh nonterminal edge labeled with the provided nonterminal.
HeapConfigurationBuilder	replaceNodeType(int node, Type newType) Sets the node type of the given node to newType.
HeapConfigurationBuilder	replaceNonterminal(int ntEdge, Nonterminal newNt) Substitutes the label of a given nonterminal edge by the provided label.
HeapConfigurationBuilder	replaceNonterminalEdge(int ntEdge, HeapConfiguration replacement) Performs hyperedge replacement for the given nonterminal edge and the given HeapConfiguration.
HeapConfigurationBuilder	replaceSelector(int node, SelectorLabel oldSel, SelectorLabel newSel) Replaces the original label of an outgoing selector edge with label 'oldSel' of node 'node' by the selector label 'newSel'.
HeapConfigurationBuilder	setExternal(int node) Marks a node as external.
HeapConfigurationBuilder	unsetExternal(int node) Marks an external node as not external.

Method Detail

build

HeapConfiguration build()

Marks the underlying HeapConfiguration as immutable again (until a new builder is requested). This method also removes the current builder. It may additionally optimize the internal structure of a HeapConfiguration before making it immutable.

Returns:

The underlying HeapConfiguration

addNodes

HeapConfigurationBuilder addNodes(Type type,
                                  int count,
                                  gnu.trove.list.array.TIntArrayList buffer)

Add count nodes of Type type to the underlying graph. The IDs of the added nodes are stored in the provided buffer.

Parameters:

type - Type of the nodes to be created.

count - The number of nodes to be created.

buffer - A list in which all created nodes are added.

Returns:

The originally used HeapConfigurationBuilder.

removeIsolatedNode

HeapConfigurationBuilder removeIsolatedNode(int node)

Removes an isolated node from the underlying HeapConfiguration

Parameters:

node - ID of the node to remove

Returns:

the builder

removeNode

HeapConfigurationBuilder removeNode(int node)

Removes the given node from the underlying HeapConfiguration. This method also removes all edges attached to the node.

Parameters:

node - ID of the node to remove

Returns:

the builder

addSelector

HeapConfigurationBuilder addSelector(int from,
                                     SelectorLabel sel,
                                     int to)

Adds a new selector edge that is labeled with 'sel' and points from node 'from' to node 'to'.

Parameters:

from - source of the selector edge

sel - label of the selector edge

to - target of the selector edge

Returns:

the builder

removeSelector

HeapConfigurationBuilder removeSelector(int node,
                                        SelectorLabel sel)

Removes an outgoing selector edge with the provided label 'sel' from the node 'node'. Nothing happens if the selector does not exist.

Parameters:

node - The node whose selector edges are taken into account.

sel - The label of the selector edge that should be deleted.

Returns:

the builder

replaceSelector

HeapConfigurationBuilder replaceSelector(int node,
                                         SelectorLabel oldSel,
                                         SelectorLabel newSel)

Replaces the original label of an outgoing selector edge with label 'oldSel' of node 'node' by the selector label 'newSel'. Nothing happens if no such selector edge exists.

Parameters:

node - The node whose selector edges are taken into account.

oldSel - The original label of the selector edge to be replaced.

newSel - The new label of the selector edge to be replaced.

Returns:

the builder

setExternal

HeapConfigurationBuilder setExternal(int node)

Marks a node as external.

Parameters:

node - The (not external yet) not to mark.

Returns:

the builder

unsetExternal

HeapConfigurationBuilder unsetExternal(int node)

Marks an external node as not external.

Parameters:

node - The external node.

Returns:

the builder

addVariableEdge

HeapConfigurationBuilder addVariableEdge(String name,
                                         int target)

Adds a new, not already existing, variable edge and attaches it to the given target node.

Parameters:

name - Name of the new variable.

target - The node the new variable edge is attached to.

Returns:

the builder

removeVariableEdge

HeapConfigurationBuilder removeVariableEdge(int varEdge)

Removes the provided variable edge.

Parameters:

varEdge - The variable edge that should be removed.

Returns:

the builder

addNonterminalEdge

HeapConfigurationBuilder addNonterminalEdge(Nonterminal label,
                                            gnu.trove.list.array.TIntArrayList attachedNodes)

Adds a new nonterminal edge.

Parameters:

label - The label of the new edge.

attachedNodes - The list of nodes attached to the new edge. The size of this list must coincide with the rank of label.

Returns:

the builder

addNonterminalEdgeAndReturnId

int addNonterminalEdgeAndReturnId(Nonterminal label,
                                  gnu.trove.list.array.TIntArrayList attachedNodes)

Adds a new nonterminal edge and returns the respective id

Parameters:

label - The label of the new edge.

attachedNodes - The list of nodes attached to the new edge. The size of this list must coincide with the rank of label.

Returns:

the resulting id of the new nonterminal edge

addNonterminalEdge

NonterminalEdgeBuilder addNonterminalEdge(Nonterminal nt)

gets a nonterminalEdgeBuilder that allows to specify the tentacles of this nonterminal and add the resulting edge to the graph

Parameters:

nt - the nonterminal

Returns:

a builder for the given nonterminal and graph

removeNonterminalEdge

HeapConfigurationBuilder removeNonterminalEdge(int ntEdge)

Removes a given nonterminal edge.

Parameters:

ntEdge - The nonterminal edge to remove.

Returns:

the builder

replaceNonterminal

HeapConfigurationBuilder replaceNonterminal(int ntEdge,
                                            Nonterminal newNt)

Substitutes the label of a given nonterminal edge by the provided label. The rank of the new label has to coincide with the rank of the original label.

Parameters:

ntEdge - The nonterminal edge whose label should be changed.

newNt - The new nonterminal label.

Returns:

the builder

replaceNonterminalEdge

HeapConfigurationBuilder replaceNonterminalEdge(int ntEdge,
                                                HeapConfiguration replacement)

Performs hyperedge replacement for the given nonterminal edge and the given HeapConfiguration. The rank of ntEdge, i.e. the number of nodes attached to it, and the number of external nodes of replacement have to coincide.

Parameters:

ntEdge - The nonterminal edge that should be replaced.

replacement - The HeapConfiguration that should replace the hyperedge.

Returns:

the builder

replaceMatching

HeapConfigurationBuilder replaceMatching(Matching matching,
                                         Nonterminal nonterminal)

Replaces the graph captured by the provided matching by a fresh nonterminal edge labeled with the provided nonterminal. The rank of the nonterminal and the number of external nodes of the pattern graph contained in the matching

Parameters:

matching - A matching of a pattern graph in the current graph.

nonterminal - The label of the nonterminal edge to be created.

Returns:

the builder

replaceNodeType

HeapConfigurationBuilder replaceNodeType(int node,
                                         Type newType)

Sets the node type of the given node to newType.

Parameters:

node - The node whose type should be changed.

newType - The new type assigned to the node.

Returns:

the builder

replaceMatchingWithCollapsedExternals

HeapConfigurationBuilder replaceMatchingWithCollapsedExternals(Matching matching,
                                                               Nonterminal nonterminal,
                                                               gnu.trove.list.array.TIntArrayList externalIndicesMap)

Replaces the graph captured by the provided matching by a fresh nonterminal edge labeled with the provided nonterminal. The rank of the nonterminal and the number of external nodes of the pattern graph contained in the matching do not have to coincide as long as the rank matches the size provided externalIndicesMap. In this case, additional tentacles will be added according to that map.

Parameters:

matching - A matching of a pattern graph in the current graph.

nonterminal - The label of the nonterminal edge to be created.

externalIndicesMap -

Returns:

the builder

mergeExternals

HeapConfigurationBuilder mergeExternals(gnu.trove.list.array.TIntArrayList extIndicesMap)

Merges external nodes according to the provided index map.

Parameters:

extIndicesMap - A mapping from external node positions in the current graph to external node positions in the resulting graph, e.g. {0,1,2,0} in order to merge the first and last node.

Returns:

the builder