UndirectedMultigraph (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.graph.UndirectedMultigraph<T>

All Implemented Interfaces:

Graph<TypedEdge<T>>, Multigraph<T,TypedEdge<T>>, Serializable
```
public class UndirectedMultigraph<T>
extends Object
implements Multigraph<T,TypedEdge<T>>, Serializable
```
A directed multigraph implementation.

Author:

David Jurgens

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`UndirectedMultigraph()` Creates an empty graph with node edges
`UndirectedMultigraph(Graph<? extends TypedEdge<T>> g)` Creates a directed multigraph with a copy of all the vertices and edges in `g`.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(int vertex)` Adds a vertex with the provided index to the graph, returning `true` if the vertex was not previously present (optional operation).
`boolean`	`add(TypedEdge<T> e)` Adds an edge between the two vertices, returning `true` if the edge was not previously present (optional operation).
`void`	`clear()` Removes all the edges and vertices from this graph (optional operation).
`void`	`clearEdges()` Removes all the edges in this graph, retaining all the vertices (optional operation).
`void`	`clearEdges(T edgeType)` Removes all the edges in the graph with the specified edge type.
`boolean`	`contains(Edge e)` Returns `true` if this graph contains an edge of the specific type between `vertex1` and `vertex2`.
`boolean`	`contains(int vertex)` Returns `true` if this graph a vertex with the specified index
`boolean`	`contains(int vertex1, int vertex2)` Returns `true` if this graph contains an edge between `from` and `to`.
`boolean`	`contains(int vertex1, int vertex2, T edgeType)` Returns `true` if there exists an edge between `vertex1` and `vertex2` of the specified type.
`UndirectedMultigraph<T>`	`copy(Set<Integer> toCopy)` Creates a copy of this graph containing only the specified number of vertices and all edges between those vertices.
`int`	`degree(int vertex)` Returns the number of edges that connect this vertex to other vertices in this graph.
`Set<TypedEdge<T>>`	`edges()` Returns the set of typed edges in the graph
`Set<TypedEdge<T>>`	`edges(T t)` Returns the set of edges with the corresponding type or the empty set if no edges of that exist.
`Set<T>`	`edgeTypes()` Returns the set of edge types currently present in this graph.
`boolean`	`equals(Object o)`
`Set<TypedEdge<T>>`	`getAdjacencyList(int vertex)` Returns the set of typed edges connected to the vertex.
`Set<TypedEdge<T>>`	`getEdges(int vertex1, int vertex2)` Returns the set of `TypedEdge` instances that connect the two vertices.
`Set<TypedEdge<T>>`	`getEdges(int vertex1, int vertex2, Set<T> types)`
`IntSet`	`getNeighbors(int vertex)` Returns the set of vertices that are connected to the specified vertex, or an empty set if the vertex is not in this graph.
`boolean`	`hasCycles()` Computes whether this graph is acyclic with its current set of edges, and returns `true` if this graph contains cycles, `false` if acyclic.
`int`	`hashCode()`
`int`	`order()` Returns the number of vertices in this graph.
`boolean`	`remove(int vertex)` Removes the vertex and all of its connected edges from the graph (optional operation).
`boolean`	`remove(TypedEdge<T> edge)` Removes the edge from `vertex1` to `vertex2`, returning `true` if the edge existed and was removed (optional operation).
`int`	`size()` Returns the number of edges in this graph.
`UndirectedMultigraph<T>`	`subgraph(Set<Integer> subset)` Returns a view of this graph containing only the specified vertices where the returned graph's vertinces are renamed (0, ..., n).
`UndirectedMultigraph<T>`	`subgraph(Set<Integer> subset, Set<T> edgeTypes)` Returns a subgraph of this graph containing only the specified vertices and edges of the specified types.
`String`	`toString()` Returns a description of the graph as the sequence of its edges.
`IntSet`	`vertices()` Returns the set of vertices in this graph.

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

- Constructor Detail
  - UndirectedMultigraph
```
public UndirectedMultigraph()
```
    Creates an empty graph with node edges
  - UndirectedMultigraph
```
public UndirectedMultigraph(Graph<? extends TypedEdge<T>> g)
```
    Creates a directed multigraph with a copy of all the vertices and edges in g.
- Method Detail
  - add
```
public boolean add(int vertex)
```
    Adds a vertex with the provided index to the graph, returning true if the vertex was not previously present (optional operation).
    
    Specified by:
    
    add in interface Graph<TypedEdge<T>>
    
    Parameters:
    vertex - a non-negative index for a vertex. If the graph has size bounds (i.e. a limited number of vertices), the implementation may throw an exception if this index exceeds those bounds.
    
    Returns:
    if the vertex was not previously present
  - add
```
public boolean add(TypedEdge<T> e)
```
    Adds an edge between the two vertices, returning true if the edge was not previously present (optional operation).
    If adding this edge would violate some structural constraints on the graph, implementations may return false or throw a GraphConstructionException. If false is returned, the called may check whether the edge was added using containsEdge
    Implemenations are free to decide the behavior for cases where one or both of the vertices are not currently in the graph, and whether self-edges are allowed (i.e. vertex1 == vertex2).
    
    Specified by:
    
    add in interface Graph<TypedEdge<T>>
    
    Returns:
    true if the edge was added, false if the edge was not added, or if the edge was aready present
    See Also:
    #containsEdge(int, int)
  - clear
```
public void clear()
```
    Removes all the edges and vertices from this graph (optional operation).
    
    Specified by:
    
    clear in interface Graph<TypedEdge<T>>
  - clearEdges
```
public void clearEdges()
```
    Removes all the edges in this graph, retaining all the vertices (optional operation).
    
    Specified by:
    
    clearEdges in interface Graph<TypedEdge<T>>
  - clearEdges
```
public void clearEdges(T edgeType)
```
    Removes all the edges in the graph with the specified edge type.
    
    Specified by:
    
    clearEdges in interface Multigraph<T,TypedEdge<T>>
  - contains
```
public boolean contains(int vertex)
```
    Returns true if this graph a vertex with the specified index
    
    Specified by:
    
    contains in interface Graph<TypedEdge<T>>
  - contains
```
public boolean contains(Edge e)
```
    Returns true if this graph contains an edge of the specific type between vertex1 and vertex2.
    
    Specified by:
    
    contains in interface Graph<TypedEdge<T>>
  - contains
```
public boolean contains(int vertex1,
               int vertex2)
```
    Returns true if this graph contains an edge between from and to. Imeplementations are free to define whether the ordering of the vertices matters.
    
    Specified by:
    
    contains in interface Graph<TypedEdge<T>>
  - contains
```
public boolean contains(int vertex1,
               int vertex2,
               T edgeType)
```
    Returns true if there exists an edge between vertex1 and vertex2 of the specified type.
    
    Specified by:
    
    contains in interface Multigraph<T,TypedEdge<T>>
  - copy
```
public UndirectedMultigraph<T> copy(Set<Integer> toCopy)
```
    Creates a copy of this graph containing only the specified number of vertices and all edges between those vertices. If vertices is empty a new, empty graph of this instance's type is returned. Any changes made to this graph will not be reflected in returned copy or vice-versa.
    
    Specified by:
    
    copy in interface Graph<TypedEdge<T>>
    
    Specified by:
    
    copy in interface Multigraph<T,TypedEdge<T>>
  - degree
```
public int degree(int vertex)
```
    Returns the number of edges that connect this vertex to other vertices in this graph. If the provided vertex is not in graph, this method returns 0.
    
    Specified by:
    
    degree in interface Graph<TypedEdge<T>>
  - edges
```
public Set<TypedEdge<T>> edges()
```
    Returns the set of typed edges in the graph
    
    Specified by:
    
    edges in interface Graph<TypedEdge<T>>
    
    Specified by:
    
    edges in interface Multigraph<T,TypedEdge<T>>
  - edges
```
public Set<TypedEdge<T>> edges(T t)
```
    Returns the set of edges with the corresponding type or the empty set if no edges of that exist.
    
    Specified by:
    
    edges in interface Multigraph<T,TypedEdge<T>>
  - edgeTypes
```
public Set<T> edgeTypes()
```
    Returns the set of edge types currently present in this graph.
    
    Specified by:
    
    edgeTypes in interface Multigraph<T,TypedEdge<T>>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getAdjacencyList
```
public Set<TypedEdge<T>> getAdjacencyList(int vertex)
```
    Returns the set of typed edges connected to the vertex.
    
    Specified by:
    
    getAdjacencyList in interface Graph<TypedEdge<T>>
    
    Specified by:
    
    getAdjacencyList in interface Multigraph<T,TypedEdge<T>>
  - getEdges
```
public Set<TypedEdge<T>> getEdges(int vertex1,
                         int vertex2)
```
    Returns the set of TypedEdge instances that connect the two vertices. If no edges connect the vertices, the set will be empty but non-null.
    
    Specified by:
    
    getEdges in interface Graph<TypedEdge<T>>
    
    Specified by:
    
    getEdges in interface Multigraph<T,TypedEdge<T>>
  - getEdges
```
public Set<TypedEdge<T>> getEdges(int vertex1,
                         int vertex2,
                         Set<T> types)
```
  - getNeighbors
```
public IntSet getNeighbors(int vertex)
```
    Returns the set of vertices that are connected to the specified vertex, or an empty set if the vertex is not in this graph.
    
    Specified by:
    
    getNeighbors in interface Graph<TypedEdge<T>>
  - hasCycles
```
public boolean hasCycles()
```
    Computes whether this graph is acyclic with its current set of edges, and returns true if this graph contains cycles, false if acyclic.
    
    Specified by:
    
    hasCycles in interface Graph<TypedEdge<T>>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - order
```
public int order()
```
    Returns the number of vertices in this graph.
    
    Specified by:
    
    order in interface Graph<TypedEdge<T>>
  - remove
```
public boolean remove(int vertex)
```
    Removes the vertex and all of its connected edges from the graph (optional operation).
    
    Specified by:
    
    remove in interface Graph<TypedEdge<T>>
  - remove
```
public boolean remove(TypedEdge<T> edge)
```
    Removes the edge from vertex1 to vertex2, returning true if the edge existed and was removed (optional operation).
    
    Specified by:
    
    remove in interface Graph<TypedEdge<T>>
  - size
```
public int size()
```
    Returns the number of edges in this graph.
    
    Specified by:
    
    size in interface Graph<TypedEdge<T>>
  - subgraph
```
public UndirectedMultigraph<T> subgraph(Set<Integer> subset)
```
    Returns a view of this graph containing only the specified vertices where the returned graph's vertinces are renamed (0, ..., n). This renaming is to ensure a conceptual distance between the "new" returned graph and the backing graph in terms of vertex labeling; for example, adding vertex n to the subgraph may not necessarily correspond to vertex n in the backing graph.
    Only edges connecting two vertices in the provided set will be viewable in the subgraph. Any changes to the subgraph will be reflected in this graph and vice versa.
    This view allows for direct manipulation of a part of the graph. For example, clearing this subgraph will remove all of its corresponding vertices and edges from the backing graph.
    
    Specified by:
    
    subgraph in interface Graph<TypedEdge<T>>
    
    Specified by:
    
    subgraph in interface Multigraph<T,TypedEdge<T>>
    
    Parameters:
    subset - the vertices to include in the subgraph
  - subgraph
```
public UndirectedMultigraph<T> subgraph(Set<Integer> subset,
                               Set<T> edgeTypes)
```
    Returns a subgraph of this graph containing only the specified vertices and edges of the specified types. Note that if all of the vertices are specified, this method can be used to extract edge-type-specific versions of this multigraph. Any attempt subsequent attempt to add an edge of a type other than the specified types to this subgraph will fail. Implementations are free to specify whether this will be an exception
    
    Specified by:
    
    subgraph in interface Multigraph<T,TypedEdge<T>>
  - toString
```
public String toString()
```
    Returns a description of the graph as the sequence of its edges.
    
    Overrides:
    
    toString in class Object
  - vertices
```
public IntSet vertices()
```
    Returns the set of vertices in this graph.
    
    Specified by:
    
    vertices in interface Graph<TypedEdge<T>>

Class UndirectedMultigraph<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UndirectedMultigraph

UndirectedMultigraph

Method Detail

add

add

clear

clearEdges

clearEdges

contains

contains

contains

contains

copy

degree

edges

edges

edgeTypes

equals

getAdjacencyList

getEdges

getEdges

getNeighbors

hasCycles

hashCode

order

remove

remove

size

subgraph

subgraph

toString

vertices