java.lang.Object

org.jhotdraw8.graph.AbstractDirectedGraphBuilder

org.jhotdraw8.graph.SimpleMutableDirectedGraph<V,A>

Type Parameters:: V - the vertex data type; A - the arrow data type

All Implemented Interfaces:: AttributedIndexedDirectedGraph<V,A>, BareDirectedGraph<V,A>, BareDirectedVertexGraph<V>, DirectedGraph<V,A>, IndexedDirectedGraph, MutableDirectedGraph<V,A>

public class SimpleMutableDirectedGraph<V,A> extends AbstractDirectedGraphBuilder implements MutableDirectedGraph<V,A>, AttributedIndexedDirectedGraph<V,A>

SimpleMutableDirectedGraph.

Author:: Werner Randelshofer

Field Summary

Fields inherited from class org.jhotdraw8.graph.AbstractDirectedGraphBuilder
arrowCountIncludingDeletedArrows, ARROWS_NEXT_FIELD, ARROWS_NUM_FIELDS, ARROWS_VERTEX_FIELD, LASTARROW_COUNT_FIELD, LASTARROW_NUM_FIELDS, LASTARROW_POINTER_FIELD, SENTINEL
Constructor Summary

Constructors

Constructor

Description

SimpleMutableDirectedGraph()

Creates a new instance with an initial capacity for 16 vertices and 16 arrows.

SimpleMutableDirectedGraph(int vertexCapacity, int arrowCapacity)

Creates a new instance with the specified initial capacities.

SimpleMutableDirectedGraph(int vertexCapacity, int arrowCapacity, boolean identityMap)

Creates a new instance with the specified initial capacities.

SimpleMutableDirectedGraph(@NonNull DirectedGraph<V,A> graph)

Creates a new instance which contains a copy of the specified graph.

SimpleMutableDirectedGraph(@NonNull DirectedGraph<VV,AA> graph, @NonNull Function<VV,V> vertexMapper, @NonNull Function3<VV,VV,AA,A> arrowMapper)

Creates a new instance which contains a copy of the specified graph.
Method Summary

Modifier and Type

Method

Description

void

addArrow(@NonNull V va, @NonNull V vb, @Nullable A arrow)

Adds a directed arrow from va to vb.

void

addBidiArrow(@NonNull V va, @NonNull V vb, A arrow)

Adds an arrow from 'va' to 'vb' and an arrow from 'vb' to 'va'.

void

addVertex(@NonNull V v)

Adds a vertex.

void

addVertex(@NonNull V v, int vidx)

Adds a vertex at the specified index.

void

clear()

@NonNull A

getArrow(int index)

Returns the data of the specified arrow.

@NonNull V

getNext(@NonNull V v, int i)

Returns the next vertex associated with the specified vertex and outgoing arrow index.

@NonNull A

getNextArrow(int v, int index)

Returns the specified successor (next) arrow of the specified vertex.

@NonNull A

getNextArrow(@NonNull V v, int index)

Returns the arrow data associated with the specified vertex and outgoing arrow index.

int

getNextArrowAsInt(int v, int i)

Returns the i-th next arrow of v.

int

getNextCount(@NonNull V v)

Returns the number of next vertices at the specified vertex.

@NonNull V

getVertex(int vi)

Gets the vertex data at the specified index.

int

getVertexIndex(V v)

Returns the index of the vertex.

@NonNull Set<V>

getVertices()

Returns all vertices.

void

removeArrow(@NonNull V v, @NonNull V u)

Removes the first arrow from vertex v to vertex u.

void

removeArrow(@NonNull V v, @NonNull V u, @Nullable A a)

Removes the first arrow from vertex v to vertex u that has the same data value.

void

removeNext(@NonNull V v, int k)

Removes the k-th next arrow from vertex v.

void

removeVertex(@NonNull V v)

Removes a vertex from the graph if it is in the graph.

Methods inherited from class org.jhotdraw8.graph.AbstractDirectedGraphBuilder
buildAddArrow, buildAddVertex, buildInsertVertexAt, buildRemoveArrowAt, buildRemoveArrowAt, buildRemoveVertex, buildRemoveVertexAfterArrowsHaveBeenRemoved, doAddArrow, getArrowCount, getArrowIndex, getNextArrowIndex, getNextAsInt, getNextCount, getNextVerticesOrdered, getNextVerticesUnordered, getVertexCount, isOrdered, nextVerticesEnumerator, setOrdered

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

Methods inherited from interface org.jhotdraw8.graph.AttributedIndexedDirectedGraph
getNextIntEntries

Methods inherited from interface org.jhotdraw8.graph.DirectedGraph
findArrow, findIndexOfNext, getArrowCount, getArrows, getArrows, getNextArc, getNextArcs, getNextArrows, getNextVertices, getVertexCount, isNext, searchNextVertices, searchNextVertices

Methods inherited from interface org.jhotdraw8.graph.IndexedDirectedGraph
findIndexOfNextAsInt, getArrowCount, getNextAsInt, getNextCount, getVertexCount, isNextAsInt, nextVerticesEnumerator

Constructor Details
- SimpleMutableDirectedGraph
  
  public SimpleMutableDirectedGraph()
  
  Creates a new instance with an initial capacity for 16 vertices and 16 arrows.
  Uses a non-identity hash map for storing the vertices.
- SimpleMutableDirectedGraph
  
  public SimpleMutableDirectedGraph(int vertexCapacity, int arrowCapacity)
  
  Creates a new instance with the specified initial capacities.
  Uses a non-identity hash map for storing the vertices.
  
  Parameters:
  
  vertexCapacity - the initial capacity for vertices
  
  arrowCapacity - the initial capacity for arrows
- SimpleMutableDirectedGraph
  
  public SimpleMutableDirectedGraph(int vertexCapacity, int arrowCapacity, boolean identityMap)
  
  Creates a new instance with the specified initial capacities.
  
  Parameters:
  
  vertexCapacity - the initial capacity for vertices
  
  arrowCapacity - the initial capacity for arrows
  
  identityMap - whether to use an identity hash map for storing the vertices
- SimpleMutableDirectedGraph
  
  public SimpleMutableDirectedGraph(@NonNull DirectedGraph<V,A> graph)
  
  Creates a new instance which contains a copy of the specified graph.
  
  Parameters:
  
  graph - a graph
- SimpleMutableDirectedGraph
  
  public SimpleMutableDirectedGraph(@NonNull DirectedGraph<VV,AA> graph, @NonNull Function<VV,V> vertexMapper, @NonNull Function3<VV,VV,AA,A> arrowMapper)
  
  Creates a new instance which contains a copy of the specified graph.
  Uses a non-identity hash map for storing the vertices.
  
  Type Parameters:
  
  VV - the vertex data type of the graph
  
  AA - the arrow data type of the graph
  
  Parameters:
  
  graph - a graph
  
  vertexMapper - a mapping function for the vertices
  
  arrowMapper - a mapping function for the arrows
Method Details
- addArrow
  
  public void addArrow(@NonNull V va, @NonNull V vb, @Nullable A arrow)
  
  Adds a directed arrow from va to vb.
  
  Specified by:
  
  addArrow in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  va - vertex a
  
  vb - vertex b
  
  arrow - the arrow
- removeArrow
  
  public void removeArrow(@NonNull V v, @NonNull V u, @Nullable A a)
  
  Description copied from interface: MutableDirectedGraph
  
  Removes the first arrow from vertex v to vertex u that has the same data value.
  
  Specified by:
  
  removeArrow in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  v - vertex data v
  
  u - vertex data u
  
  a - arrow data
- removeArrow
  
  public void removeArrow(@NonNull V v, @NonNull V u)
  
  Description copied from interface: MutableDirectedGraph
  
  Removes the first arrow from vertex v to vertex u.
  
  Specified by:
  
  removeArrow in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  v - vertex data v
  
  u - vertex data u
- removeNext
  
  public void removeNext(@NonNull V v, int k)
  
  Description copied from interface: MutableDirectedGraph
  
  Removes the k-th next arrow from vertex v.
  
  Specified by:
  
  removeNext in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  v - vertex data v
  
  k - index of arrow to be removed
- addBidiArrow
  
  public void addBidiArrow(@NonNull V va, @NonNull V vb, A arrow)
  
  Adds an arrow from 'va' to 'vb' and an arrow from 'vb' to 'va'.
  
  Parameters:
  
  va - vertex a
  
  vb - vertex b
  
  arrow - the arrow
- addVertex
  
  public void addVertex(@NonNull V v)
  
  Adds a vertex.
  
  Specified by:
  
  addVertex in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  v - vertex
- addVertex
  
  public void addVertex(@NonNull V v, int vidx)
  
  Adds a vertex at the specified index.
  
  Parameters:
  
  v - vertex
  
  vidx - vertex index
- removeVertex
  
  public void removeVertex(@NonNull V v)
  
  Description copied from interface: MutableDirectedGraph
  
  Removes a vertex from the graph if it is in the graph.
  
  Specified by:
  
  removeVertex in interface MutableDirectedGraph<V,A>
  
  Parameters:
  
  v - vertex data
- clear
  
  public void clear()
  
  Overrides:
  
  clear in class AbstractDirectedGraphBuilder
- getNextArrow
  
  public @NonNull A getNextArrow(@NonNull V v, int index)
  
  Description copied from interface: BareDirectedGraph
  
  Returns the arrow data associated with the specified vertex and outgoing arrow index.
  Specified by:
  
  getNextArrow in interface BareDirectedGraph<V,A>
  
  Parameters:
  
  v - a vertex
  
  index - index of outgoing arrow
  
  Returns:
  
  the next arrow data
  
  See Also:
  
  BareDirectedVertexGraph.getNextCount(V)
- getNext
  
  public @NonNull V getNext(@NonNull V v, int i)
  
  Description copied from interface: BareDirectedVertexGraph
  
  Returns the next vertex associated with the specified vertex and outgoing arrow index.
  Specified by:
  
  getNext in interface BareDirectedVertexGraph<V>
  
  Parameters:
  
  v - a vertex
  
  i - index of outgoing arrow
  
  Returns:
  
  the next vertex
  
  See Also:
  
  BareDirectedVertexGraph.getNextCount(V)
- getNextCount
  
  public int getNextCount(@NonNull V v)
  
  Description copied from interface: BareDirectedVertexGraph
  
  Returns the number of next vertices at the specified vertex.
  This number is the same as the number of outgoing arrows at the specified vertex.
  
  Specified by:
  
  getNextCount in interface BareDirectedVertexGraph<V>
  
  Parameters:
  
  v - a vertex
  
  Returns:
  
  the number of next vertices
- getVertex
  
  public @NonNull V getVertex(int vi)
  
  Description copied from interface: DirectedGraph
  
  Gets the vertex data at the specified index.
  
  Specified by:
  
  getVertex in interface AttributedIndexedDirectedGraph<V,A>
  
  Specified by:
  
  getVertex in interface DirectedGraph<V,A>
  
  Parameters:
  
  vi - an index
  
  Returns:
  
  vertex data
- getVertexIndex
  
  public int getVertexIndex(V v)
  
  Description copied from interface: AttributedIndexedDirectedGraph
  
  Returns the index of the vertex.
  
  Specified by:
  
  getVertexIndex in interface AttributedIndexedDirectedGraph<V,A>
  
  Parameters:
  
  v - a vertex
  
  Returns:
  
  index of vertex
- getArrow
  
  public @NonNull A getArrow(int index)
  
  Description copied from interface: AttributedIndexedDirectedGraph
  
  Returns the data of the specified arrow.
  
  Specified by:
  
  getArrow in interface AttributedIndexedDirectedGraph<V,A>
  
  Parameters:
  
  index - index of arrow
  
  Returns:
  
  arrow data
- getNextArrow
  
  public @NonNull A getNextArrow(int v, int index)
  
  Description copied from interface: AttributedIndexedDirectedGraph
  
  Returns the specified successor (next) arrow of the specified vertex.
  
  Specified by:
  
  getNextArrow in interface AttributedIndexedDirectedGraph<V,A>
  
  Parameters:
  
  v - a vertex
  
  index - index of next arrow
  
  Returns:
  
  the specified arrow
- getNextArrowAsInt
  
  public int getNextArrowAsInt(int v, int i)
  
  Description copied from interface: IndexedDirectedGraph
  
  Returns the i-th next arrow of v.
  
  Specified by:
  
  getNextArrowAsInt in interface IndexedDirectedGraph
  
  Parameters:
  
  v - a vertex index
  
  i - the index of the desired arrow, i ∈ {0, ..., getNextCount(v) -1 }.
  
  Returns:
  
  the arrow data of the i-th next vertex of v.
- getVertices
  
  public @NonNull Set<V> getVertices()
  
  Description copied from interface: BareDirectedVertexGraph
  
  Returns all vertices.
  
  Specified by:
  
  getVertices in interface BareDirectedVertexGraph<V>
  
  Returns:
  
  a set view on all vertices

Class SimpleMutableDirectedGraph<V,A>

Field Summary

Fields inherited from class org.jhotdraw8.graph.AbstractDirectedGraphBuilder

Constructor Summary

Method Summary

Methods inherited from class org.jhotdraw8.graph.AbstractDirectedGraphBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.jhotdraw8.graph.AttributedIndexedDirectedGraph

Methods inherited from interface org.jhotdraw8.graph.DirectedGraph

Methods inherited from interface org.jhotdraw8.graph.IndexedDirectedGraph

Constructor Details

SimpleMutableDirectedGraph

SimpleMutableDirectedGraph

SimpleMutableDirectedGraph

SimpleMutableDirectedGraph

SimpleMutableDirectedGraph

Method Details

addArrow

removeArrow

removeArrow

removeNext

addBidiArrow

addVertex

addVertex

removeVertex

clear

getNextArrow

getNext

getNextCount

getVertex

getVertexIndex

getArrow

getNextArrow

getNextArrowAsInt

getVertices