edu.ucla.sspace.graph

Interface DynamicGraph

All Superinterfaces:

Graph

public interface DynamicGraph
extends Graph

A stub interface for Graph instances that encode time on their vertices and edges.

Author:

David Jurgens

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEdge(int vertex1, int vertex2) Adds an edge between the two vertices, returning true if the edge was not previously present.
boolean	addEdge(int vertex1, int vertex2, Calendar start, Calendar end)
boolean	addEdge(int vertex1, int vertex2, Date start, Date end)
boolean	addEdge(int vertex1, int vertex2, long start, long end)
boolean	addVertex(int i) Adds a vertex with the provided index to the graph, returning true if the vertex was not previously present.
boolean	addVertex(int i, Calendar start, Calendar end)
boolean	addVertex(int i, Date start, Date end)
boolean	addVertex(int i, long start, long end)
void	clear() Removes all the edges and vertices from this graph
void	clearEdges() Removes all the edges in this graph, retaining all the vertices.
boolean	containsEdge(int vertex1, int vertex2, Calendar atTime) Returns true if this graph contains an edge between vertex1 and vertex2.
boolean	containsEdge(int vertex1, int vertex2, Date atTime)
boolean	containsEdge(int vertex1, int vertex2, long atTime)
Set<? extends TemporalEdge>	edges() Returns the set of edges contained in this graph.
Set<? extends TemporalEdge>	getAdjacencyList(int vertex) Returns the set of edges connected to the provided vertex.
TemporalEdge	getEdge(int vertex1, int vertex2) Returns the Edge instance connecting the two vertices or null if the vertices are not connected.
Graph	subgraph(IntSet vertices) Returns a view of this graph containing only the specified vertices.
Graph	subgraph(IntSet vertices, Calendar atTime)
Graph	subgraph(IntSet vertices, Calendar startTime, Calendar endTime)
Graph	subgraph(IntSet vertices, Date atTime)
Graph	subgraph(IntSet vertices, Date startTime, Date endTime)
Graph	subgraph(IntSet vertices, long atTime)
Graph	subgraph(IntSet vertices, long startTime, long endTime)

Methods inherited from interface edu.ucla.sspace.graph.Graph

add, add, contains, contains, contains, copy, degree, getEdges, getNeighbors, hasCycles, order, remove, remove, size, subgraph, vertices

Method Detail

addVertex

boolean addVertex(int i)

Adds a vertex with the provided index to the graph, returning true if the vertex was not previously present.

Parameters:

i - 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

Throws:

IllegalArgumentException - if i is negative or beyond the number of representable vertices in the current instance

addVertex

boolean addVertex(int i,
                Calendar start,
                Calendar end)

addVertex

boolean addVertex(int i,
                Date start,
                Date end)

addVertex

boolean addVertex(int i,
                long start,
                long end)

addEdge

boolean addEdge(int vertex1,
              int vertex2)

Adds an edge between the two vertices, returning true if the edge was not previously present. 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).

addEdge

boolean addEdge(int vertex1,
              int vertex2,
              Calendar start,
              Calendar end)

addEdge

boolean addEdge(int vertex1,
              int vertex2,
              Date start,
              Date end)

addEdge

boolean addEdge(int vertex1,
              int vertex2,
              long start,
              long end)

clear

void clear()

Removes all the edges and vertices from this graph

Specified by:

clear in interface Graph

clearEdges

void clearEdges()

Removes all the edges in this graph, retaining all the vertices.

Specified by:

clearEdges in interface Graph

containsEdge

boolean containsEdge(int vertex1,
                   int vertex2,
                   Calendar atTime)

Returns true if this graph contains an edge between vertex1 and vertex2.

containsEdge

boolean containsEdge(int vertex1,
                   int vertex2,
                   Date atTime)

containsEdge

boolean containsEdge(int vertex1,
                   int vertex2,
                   long atTime)

edges

Set<? extends TemporalEdge> edges()

Returns the set of edges contained in this graph.

Specified by:

edges in interface Graph

getAdjacencyList

Set<? extends TemporalEdge> getAdjacencyList(int vertex)

Returns the set of edges connected to the provided vertex.

Specified by:

getAdjacencyList in interface Graph

getEdge

TemporalEdge getEdge(int vertex1,
                   int vertex2)

Returns the Edge instance connecting the two vertices or null if the vertices are not connected.

subgraph

Graph subgraph(IntSet vertices)

Returns a view of this graph containing only the specified vertices. 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.

Parameters:

vertices - the vertices to include in the subgraph

Throws:

IllegalArgumentException - if vertices contains vertices not present in this graph

subgraph

Graph subgraph(IntSet vertices,
             Calendar atTime)

subgraph

Graph subgraph(IntSet vertices,
             Date atTime)

subgraph

Graph subgraph(IntSet vertices,
             long atTime)

subgraph

Graph subgraph(IntSet vertices,
             Calendar startTime,
             Calendar endTime)

subgraph

Graph subgraph(IntSet vertices,
             Date startTime,
             Date endTime)

subgraph

Graph subgraph(IntSet vertices,
             long startTime,
             long endTime)