LabeledDigraph (Attestor 0.3.5-SEFM2018 API)

java.lang.Object
- de.rwth.i2.attestor.graph.digraph.LabeledDigraph

```
public class LabeledDigraph
extends Object
```
A LabeledDigraph implements a directed graph with labeled nodes and labeled edges. Nodes have to be labeled with instances of NodeLabel and are represented by integers. Edges can be labeled with arbitrary objects and are identified by their source node and either their label or their position on the sequence of outgoing edges of a node. Note that multiple edges between two nodes as well as loops are allowed.

Author:

Christoph

Field Summary

Fields
Modifier and Type Field and Description

static int INVALID
Integer representing an invalid element of a LabeledDigraph.

Fields
Modifier and Type	Field and Description
`static int`	`INVALID` Integer representing an invalid element of a LabeledDigraph.

Constructor Summary

Constructors
Constructor and Description

LabeledDigraph(int capacity)
Creates a new LabeledDigraph.

LabeledDigraph(LabeledDigraph digraph)
Creates a deep copy of a given LabeledDigraph.

Constructors
Constructor and Description
`LabeledDigraph(int capacity)` Creates a new LabeledDigraph.
`LabeledDigraph(LabeledDigraph digraph)` Creates a deep copy of a given LabeledDigraph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEdge(int from, Object label, int to)` Adds a new edge from node from to node to that is labeled with label provided that the two nodes exists and label is not null.
`void`	`addNode(NodeLabel label, int successorCapacity, int predecessorCapacity)` Adds a new node with the provided label.
`boolean`	`containsEdgeLabel(int node, Object label)`
`boolean`	`containsNode(int value)`
`Object`	`edgeLabelAt(int node, int pos)`
`List<Object>`	`edgeLabelsFromTo(int from, int to)` Determines a list of all edge labels with source node 'from' and target node 'to'.
`int`	`externalNodeAt(int pos)`
`int`	`externalPosOf(int node)` Determines the position of a given node in the sequence of external nodes.
`boolean`	`isExternal(int node)`
`boolean`	`isPacked()`
`NodeLabel`	`nodeLabelOf(int node)`
`List<Object>`	`outgoingEdgeLabelsOf(int node)`
`int[]`	`pack()` Transforms this LabeledDigraph into a more compact form in which the size of the underlying data structures containsSubsumingState no "wholes" due to invalid elements anymore.
`int`	`posOfEdgeLabel(int node, Object label)` Determines the position of an outgoing edge with the provided label of the provided node.
`int`	`predecessorSizeOf(int node)`
`gnu.trove.list.array.TIntArrayList`	`predecessorsOf(int node)`
`int`	`rank()`
`boolean`	`removeEdgeAt(int node, int pos)` Removes the outgoing edge of node that is at position pos.
`boolean`	`removeEdgeLabelAt(int node, Object label)` Removes the outgoing edge of node 'node' that is labeled with 'label'
`boolean`	`removeNodeAt(int node)`
`void`	`replaceEdgeLabel(int node, Object oldLabel, Object newLabel)` Replaces all outgoing edges of the given node that are labeled with oldLabel by edges labeled with newLabel.
`void`	`replaceNodeLabel(int node, NodeLabel newLabel)` Sets the label of a node to newLabel.
`void`	`setExternal(int node)` Marks the provided node as external
`int`	`size()`
`int`	`successorSizeOf(int node)`
`gnu.trove.list.array.TIntArrayList`	`successorsOf(int node)`
`String`	`toString()`
`void`	`unsetExternal(int node)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - INVALID
```
public static final int INVALID
```
    Integer representing an invalid element of a LabeledDigraph.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LabeledDigraph
```
public LabeledDigraph(int capacity)
```
    Creates a new LabeledDigraph.
    
    Parameters:
    
    capacity - The initial capacity in terms of number of nodes that can be stored without increasing the size of underlying data structures.
  - LabeledDigraph
```
public LabeledDigraph(LabeledDigraph digraph)
```
    Creates a deep copy of a given LabeledDigraph.
    
    Parameters:
    
    digraph - The original graph.
- Method Detail
  - size
```
public int size()
```
    Returns:
    
    The number of nodes contained in this LabeledDigraph.
  - addNode
```
public void addNode(NodeLabel label,
                    int successorCapacity,
                    int predecessorCapacity)
```
    Adds a new node with the provided label.
    
    Parameters:
    
    label - The label of the new node.
    
    successorCapacity - The number of successor nodes that can be added to this node without increasing underlying data structures.
    
    predecessorCapacity - The number of predecessor nodes that can be added to this this node without increasing underlying data structures.
  - nodeLabelOf
```
public NodeLabel nodeLabelOf(int node)
```
    Parameters:
    
    node - The requested node.
    
    Returns:
    
    NodeLabel of the given node or null if the provided index does not correspond to a node.
  - containsNode
```
public boolean containsNode(int value)
```
    Parameters:
    
    value - The value that should be checked whether it corresponds to a node.
    
    Returns:
    
    True if and only if the provided value corresponds to a node.
  - removeNodeAt
```
public boolean removeNodeAt(int node)
```
    Parameters:
    
    node - The node that should be removed.
    
    Returns:
    
    True if and only if the given node exists and was successfully removed.
  - addEdge
```
public void addEdge(int from,
                    Object label,
                    int to)
```
    Adds a new edge from node from to node to that is labeled with label provided that the two nodes exists and label is not null.
    
    Parameters:
    
    from - The source node of the new edge.
    
    label - The label of the new edge.
    
    to - The target of the new edge.
  - successorSizeOf
```
public int successorSizeOf(int node)
```
    Parameters:
    
    node - A node in the graph.
    
    Returns:
    
    The number of successor nodes of the provided node. If the node is not contained in the graph, 0 is returned.
  - isPacked
```
public boolean isPacked()
```
    Returns:
    
    True if and only if this LabeledDigraph is currently 'packed'. That is, the set of all nodes contained in this graph is a compact interval of the form [0,size()-1].
  - predecessorSizeOf
```
public int predecessorSizeOf(int node)
```
    Parameters:
    
    node - The node whose predecessor nodes are requested.
    
    Returns:
    
    The number of predecessors of the given node. If the node does not belong to this graph the result is 0.
  - outgoingEdgeLabelsOf
```
public List<Object> outgoingEdgeLabelsOf(int node)
```
    Parameters:
    
    node - A node in the graph.
    
    Returns:
    
    A list of all edge labels that occur as labels of edges whose source is the provided node. If node does not belong to this graph the result is null.
  - edgeLabelAt
```
public Object edgeLabelAt(int node,
                          int pos)
```
    Parameters:
    
    node - The node whose outgoing edges are considered. More precisely, all edges having node as source are considered.
    
    pos - Ask for the outgoing edge of node at position pos.
    
    Returns:
    
    The label of the edge determined by node and pos. If node does not belong to this graph or no edge at position pos exists then null is returned.
  - removeEdgeAt
```
public boolean removeEdgeAt(int node,
                            int pos)
```
    Removes the outgoing edge of node that is at position pos.
    
    Parameters:
    
    node - The source node whose outgoing edges are considered.
    
    pos - The position determining which edge should be removed.
    
    Returns:
    
    True if and only if the edge could be removed.
  - removeEdgeLabelAt
```
public boolean removeEdgeLabelAt(int node,
                                 Object label)
```
    Removes the outgoing edge of node 'node' that is labeled with 'label'
    
    Parameters:
    
    node - The node whose outgoing edges are considered.
    
    label - The label of the edge that should be removed.
    
    Returns:
    
    True if and only if the specified edge was found and removed successfully.
  - posOfEdgeLabel
```
public int posOfEdgeLabel(int node,
                          Object label)
```
    Determines the position of an outgoing edge with the provided label of the provided node.
    
    Parameters:
    
    node - The node whose outgoing edges are considered.
    
    label - The label of the edge whose position should be determined.
    
    Returns:
    
    The position of the outgoing edge of 'node' that is labeled with 'label' or INVALID if no such edge exists.
  - setExternal
```
public void setExternal(int node)
```
    Marks the provided node as external
    
    Parameters:
    
    node - The node that should be marked as external.
  - rank
```
public int rank()
```
    Returns:
    
    The number of external nodes of this LabeledDigraph.
  - externalPosOf
```
public int externalPosOf(int node)
```
    Determines the position of a given node in the sequence of external nodes.
    
    Parameters:
    
    node - The node whose position should be determined.
    
    Returns:
    
    The position of the node in the sequence of external nodes. If the node does not exist or is not external then INVALID is returned.
  - isExternal
```
public boolean isExternal(int node)
```
    Parameters:
    
    node - The node to be checked.
    
    Returns:
    
    True if and only if the given node is marked as external.
  - unsetExternal
```
public void unsetExternal(int node)
```
    Parameters:
    
    node - The node that should be removed from the sequence of external nodes.
  - replaceEdgeLabel
```
public void replaceEdgeLabel(int node,
                             Object oldLabel,
                             Object newLabel)
```
    Replaces all outgoing edges of the given node that are labeled with oldLabel by edges labeled with newLabel.
    
    Parameters:
    
    node - The node whose outgoing edges are considered.
    
    oldLabel - The edge label that should be replaced.
    
    newLabel - The edge label used to replace oldLabel.
  - containsEdgeLabel
```
public boolean containsEdgeLabel(int node,
                                 Object label)
```
    Parameters:
    
    node - The node whose outgoing edges should be considered.
    
    label - The edge label to look for.
    
    Returns:
    
    True if and only if there is an outgoing edge of the given node that is labeled with the provided label.
  - predecessorsOf
```
public gnu.trove.list.array.TIntArrayList predecessorsOf(int node)
```
    Parameters:
    
    node - The node whose predecessors are considered.
    
    Returns:
    
    A list of all predecessor nodes of the provided node.
  - successorsOf
```
public gnu.trove.list.array.TIntArrayList successorsOf(int node)
```
    Parameters:
    
    node - The node whose successor nodes are considered.
    
    Returns:
    
    A list of all successor nodes of the provided node.
  - edgeLabelsFromTo
```
public List<Object> edgeLabelsFromTo(int from,
                                     int to)
```
    Determines a list of all edge labels with source node 'from' and target node 'to'.
    
    Parameters:
    
    from - The source node.
    
    to - The target node.
    
    Returns:
    
    A list of all edge labels of edges with source 'from' and target 'to'.
  - pack
```
public int[] pack()
```
    Transforms this LabeledDigraph into a more compact form in which the size of the underlying data structures containsSubsumingState no "wholes" due to invalid elements anymore. Whenever an invalid element is encountered it is swapped with the last valid element. After that all invalid elements are removed.
    
    Returns:
    
    An array recording all swaps performed.
  - externalNodeAt
```
public int externalNodeAt(int pos)
```
  - replaceNodeLabel
```
public void replaceNodeLabel(int node,
                             NodeLabel newLabel)
```
    Sets the label of a node to newLabel.
    
    Parameters:
    
    node - The node.
    
    newLabel - The new label of the node.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this LabeledDigraph.

Class LabeledDigraph

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID

Constructor Detail

LabeledDigraph

LabeledDigraph

Method Detail

size

addNode

nodeLabelOf

containsNode

removeNodeAt

addEdge

successorSizeOf

isPacked

predecessorSizeOf

outgoingEdgeLabelsOf

edgeLabelAt

removeEdgeAt

removeEdgeLabelAt

posOfEdgeLabel

setExternal

rank

externalPosOf

isExternal

unsetExternal

replaceEdgeLabel

containsEdgeLabel

predecessorsOf

successorsOf

edgeLabelsFromTo

pack

externalNodeAt

replaceNodeLabel

toString