Graph (deeplearning4j-nlp 0.9.1 API)

java.lang.Object
- org.deeplearning4j.models.sequencevectors.graph.primitives.Graph<V,E>

Type Parameters:

V - Type parameter for vertices (type of objects attached to each vertex)

E - Type parameter for edges (type of objects attached to each edge)

All Implemented Interfaces:

IGraph<V,E>
```
public class Graph<V extends SequenceElement,E extends Number>
extends Object
implements IGraph<V,E>
```
Graph, where all edges and vertices are stored in-memory.
Internally, this is a directed graph with adjacency list representation; however, if undirected edges are added, these edges are duplicated internally to allow for fast lookup.
Depending on the value of allowMultipleEdges, this graph implementation may or may not allow multiple edges between any two adjacent nodes. If multiple edges are required (such that two or more distinct edges between vertices X and Y exist simultaneously) then allowMultipleEdges should be set to true.
As per IGraph, this graph representation can have arbitrary objects attached
Vertices are initialized either directly via list, or via a VertexFactory. Edges are added using one of the addEdge methods.

Author:

Alex Black

Constructor Summary

Constructors
Constructor and Description
`Graph()`
`Graph(Collection<V> elements, boolean allowMultipleEdges)`
`Graph(int numVertices, boolean allowMultipleEdges, VertexFactory<V> vertexFactory)`
`Graph(int numVertices, VertexFactory<V> vertexFactory)`
`Graph(List<Vertex<V>> vertices)`
`Graph(List<Vertex<V>> vertices, boolean allowMultipleEdges)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEdge(Edge<E> edge)` Add an edge to the graph.
`void`	`addEdge(int from, int to, E value, boolean directed)` Convenience method for adding an edge (directed or undirected) to graph
`void`	`addVertex(Vertex<V> vertex, Collection<Edge<E>> edges)`
`void`	`addVertex(Vertex<V> vertex, Edge<E> edge)`
`boolean`	`equals(Object o)`
`int[]`	`getConnectedVertexIndices(int vertex)` Return an array of indexes of vertices that the specified vertex is connected to. Specifically, for undirected graphs return int[] of all X.vertexID() such that (vertex -- X) exists For directed graphs, return int[] of all X.vertexID() such that (vertex -> X) exists
`List<Vertex<V>>`	`getConnectedVertices(int vertex)` Get a list of all of the vertices that the specified vertex is connected to Specifically, for undirected graphs return list of all X such that (vertex -- X) exists For directed graphs, return list of all X such that (vertex -> X) exists
`List<Edge<E>>`	`getEdgesOut(int vertex)` Returns a list of edges for a vertex with a given index For undirected graphs, returns all edges incident on the vertex For directed graphs, only returns outward directed edges
`Vertex<V>`	`getRandomConnectedVertex(int vertex, Random rng)` Randomly sample a vertex connected to a given vertex.
`Vertex<V>`	`getVertex(int idx)` Get a vertex in the graph for a given index
`int`	`getVertexDegree(int vertex)` Returns the degree of the vertex. For undirected graphs, this is just the degree. For directed graphs, this returns the outdegree
`List<Vertex<V>>`	`getVertices(int[] indexes)` Get multiple vertices in the graph
`List<Vertex<V>>`	`getVertices(int from, int to)` Get multiple vertices in the graph, with secified indices
`int`	`hashCode()`
`int`	`numVertices()` Number of vertices in the graph
`String`	`toString()`

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

- Constructor Detail
  - Graph
```
public Graph(int numVertices,
             VertexFactory<V> vertexFactory)
```
  - Graph
```
public Graph(int numVertices,
             boolean allowMultipleEdges,
             VertexFactory<V> vertexFactory)
```
  - Graph
```
public Graph(List<Vertex<V>> vertices,
             boolean allowMultipleEdges)
```
  - Graph
```
public Graph(Collection<V> elements,
             boolean allowMultipleEdges)
```
  - Graph
```
public Graph(List<Vertex<V>> vertices)
```
  - Graph
```
public Graph()
```
- Method Detail
  - addVertex
```
public void addVertex(Vertex<V> vertex,
                      Edge<E> edge)
```
  - addVertex
```
public void addVertex(Vertex<V> vertex,
                      Collection<Edge<E>> edges)
```
  - numVertices
```
public int numVertices()
```
    Description copied from interface: IGraph
    
    Number of vertices in the graph
    
    Specified by:
    
    numVertices in interface IGraph<V extends SequenceElement,E extends Number>
  - getVertex
```
public Vertex<V> getVertex(int idx)
```
    Description copied from interface: IGraph
    
    Get a vertex in the graph for a given index
    
    Specified by:
    
    getVertex in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    idx - integer index of the vertex to get. must be in range 0 to numVertices()
    
    Returns:
    
    vertex
  - getVertices
```
public List<Vertex<V>> getVertices(int[] indexes)
```
    Description copied from interface: IGraph
    
    Get multiple vertices in the graph
    
    Specified by:
    
    getVertices in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    indexes - the indexes of the vertices to retrieve
    
    Returns:
    
    list of vertices
  - getVertices
```
public List<Vertex<V>> getVertices(int from,
                                   int to)
```
    Description copied from interface: IGraph
    
    Get multiple vertices in the graph, with secified indices
    
    Specified by:
    
    getVertices in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    from - first vertex to get, inclusive
    
    to - last vertex to get, inclusive
    
    Returns:
    
    list of vertices
  - addEdge
```
public void addEdge(Edge<E> edge)
```
    Description copied from interface: IGraph
    
    Add an edge to the graph.
    
    Specified by:
    
    addEdge in interface IGraph<V extends SequenceElement,E extends Number>
  - addEdge
```
public void addEdge(int from,
                    int to,
                    E value,
                    boolean directed)
```
    Convenience method for adding an edge (directed or undirected) to graph
    
    Specified by:
    
    addEdge in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    from -
    
    to -
    
    value -
    
    directed -
  - getEdgesOut
```
public List<Edge<E>> getEdgesOut(int vertex)
```
    Description copied from interface: IGraph
    
    Returns a list of edges for a vertex with a given index For undirected graphs, returns all edges incident on the vertex For directed graphs, only returns outward directed edges
    
    Specified by:
    
    getEdgesOut in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    vertex - index of the vertex to
    
    Returns:
    
    list of edges for this vertex
  - getVertexDegree
```
public int getVertexDegree(int vertex)
```
    Description copied from interface: IGraph
    
    Returns the degree of the vertex.
    For undirected graphs, this is just the degree.
    For directed graphs, this returns the outdegree
    
    Specified by:
    
    getVertexDegree in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    vertex - vertex to get degree for
    
    Returns:
    
    vertex degree
  - getRandomConnectedVertex
```
public Vertex<V> getRandomConnectedVertex(int vertex,
                                          Random rng)
                                   throws NoEdgesException
```
    Description copied from interface: IGraph
    
    Randomly sample a vertex connected to a given vertex. Sampling is done uniformly at random. Specifically, returns a random X such that either a directed edge (vertex -> X) exists, or an undirected edge (vertex -- X) exists
    Can be used for example to implement a random walk on the graph (specifically: a unweighted random walk)
    
    Specified by:
    
    getRandomConnectedVertex in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    vertex - vertex to randomly sample from
    
    rng - Random number generator to use
    
    Returns:
    
    A vertex connected to the specified vertex,
    
    Throws:
    
    NoEdgesException - thrown if the specified vertex has no edges, or no outgoing edges (in the case of a directed graph).
  - getConnectedVertices
```
public List<Vertex<V>> getConnectedVertices(int vertex)
```
    Description copied from interface: IGraph
    
    Get a list of all of the vertices that the specified vertex is connected to
    Specifically, for undirected graphs return list of all X such that (vertex -- X) exists
    For directed graphs, return list of all X such that (vertex -> X) exists
    
    Specified by:
    
    getConnectedVertices in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    vertex - Index of the vertex
    
    Returns:
    
    list of vertices that the specified vertex is connected to
  - getConnectedVertexIndices
```
public int[] getConnectedVertexIndices(int vertex)
```
    Description copied from interface: IGraph
    
    Return an array of indexes of vertices that the specified vertex is connected to.
    Specifically, for undirected graphs return int[] of all X.vertexID() such that (vertex -- X) exists
    For directed graphs, return int[] of all X.vertexID() such that (vertex -> X) exists
    
    Specified by:
    
    getConnectedVertexIndices in interface IGraph<V extends SequenceElement,E extends Number>
    
    Parameters:
    
    vertex - index of the vertex
    
    Returns:
    
    list of vertices that the specified vertex is connected to
    
    See Also:
    
    IGraph.getConnectedVertices(int)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Graph<V extends SequenceElement,E extends Number>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Graph

Graph

Graph

Graph

Graph

Graph

Method Detail

addVertex

addVertex

numVertices

getVertex

getVertices

getVertices

addEdge

addEdge

getEdgesOut

getVertexDegree

getRandomConnectedVertex

getConnectedVertices

getConnectedVertexIndices

toString

equals

hashCode