Graph (graphlib 1.0.1 API)

java.lang.Object
- io.github.openlg.graphlib.Graph<N,E>

所有已实现的接口:

Serializable
```
public class Graph<N,E>
extends Object
implements Serializable
```
A directed multi-graph library

作者:

lg Create by lg on 4/22/20 6:17 AM

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

Graph()

Graph(boolean directed, boolean multigraph, boolean compound)

构造器
构造器和说明
`Graph()`
`Graph(boolean directed, boolean multigraph, boolean compound)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`List<Graph<N,E>>`	`components()` Finds all connected components in a graph and returns an array of these components.
`int`	`edgeCount()` Returns the number of edges in the graph.
`Graph<N,E>`	`filterNodes(Predicate<String> filter)`
`List<List<String>>`	`findCycles()` Find cycles.
`Collection<String>`	`getChildren(String nodeId)`
`E`	`getEdge(Edge edge)`
`E`	`getEdge(String sourceId, String targetId)`
`E`	`getEdge(String sourceId, String targetId, String name)` get edge
`Collection<Edge>`	`getEdges()` Returns the Edge for each getEdge in the graph.
`N`	`getNode(String nodeId)`
`Collection<String>`	`getNodes()` Get node
`String`	`getParent(String nodeId)`
`Set<String>`	`getSinks()` Returns those node in the graph that have no out-edge.
`Set<String>`	`getSources()` Returns those node in the graph that have no in-edge.
`boolean`	`hasEdge(Edge edge)`
`boolean`	`hasEdge(String sourceId, String targetId)`
`boolean`	`hasEdge(String sourceId, String targetId, String name)` exist edge
`boolean`	`hasNode(String id)` Returns true if the graph has a node with the id.
`Collection<Edge>`	`inEdges(String nodeId)`
`Collection<Edge>`	`inEdges(String nodeId, String sourceId)` Return all edge that point to the node v.
`boolean`	`isAcyclic()` This method returns true if the graph has no cycles and returns false if it does.
`boolean`	`isCompound()`
`boolean`	`isDirected()`
`boolean`	`isLeaf(String nodeId)`
`boolean`	`isMultiGraph()`
`Collection<String>`	`neighbors(String nodeId)`
`int`	`nodeCount()` Returns the number of node in the graph.
`Collection<Edge>`	`nodeEdges(String nodeId)`
`Collection<Edge>`	`nodeEdges(String nodeId, String connectedNodeId)` Returns all edgeLabels to or from node nodeId regardless of direction.
`Collection<Edge>`	`outEdges(String nodeId)`
`Collection<Edge>`	`outEdges(String nodeId, String targetId)` Return all edge that are pointed at by node v.
`Collection<String>`	`predecessors(String nodeId)`
`Graph<N,E>`	`removeEdge(Edge edge)` remove edge
`Graph<N,E>`	`removeEdge(String sourceId, String targetId)` remove edge
`Graph<N,E>`	`removeEdge(String sourceId, String targetId, String name)` remove edge
`Graph<N,E>`	`removeNode(String id)` Remove the node with the id in the graph or do nothing if the node is not in the graph.
`void`	`setCompound(boolean compound)`
`void`	`setDirected(boolean directed)`
`Graph<N,E>`	`setEdge(Edge edge)` add new edge
`Graph<N,E>`	`setEdge(Edge edge, E e)` add new edge
`Graph<N,E>`	`setEdge(String sourceId, String targetId)` add edge
`Graph<N,E>`	`setEdge(String sourceId, String targetId, E e)` add edge
`Graph<N,E>`	`setEdge(String sourceId, String targetId, E e, String name)` add new edge
`void`	`setMultiGraph(boolean multiGraph)`
`Graph<N,E>`	`setNode(String id)` Creates or updates the value for the node in the graph.
`Graph<N,E>`	`setNode(String id, N n)` Creates or updates the value for the node in the graph.
`Graph<N,E>`	`setNodes(Collection<String> nodes)` Creates or updates the value for the nodes in the graph.
`Graph<N,E>`	`setNodes(Collection<String> nodes, N n)` Creates or updates the value for the nodes in the graph.
`Graph<N,E>`	`setParent(String nodeId, String parentId)`
`Graph<N,E>`	`setPath(Collection<String> path)` add multi edge by path
`Graph<N,E>`	`setPath(Collection<String> path, E e)` add multi edge by node id's
`Graph<N,E>`	`setPath(String... nodeId)` add multi edge by node id's
`Collection<String>`	`successors(String nodeId)`
`List<List<String>>`	`tarjan()` This function is an implementation of Tarjan's algorithm which finds all strongly connected components in the directed graph g.
`List<String>`	`topsort()` An implementation of topological sorting (https://en.wikipedia.org/wiki/Topological_sorting).

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Graph
```
public Graph()
```
  - Graph
```
public Graph(boolean directed,
             boolean multigraph,
             boolean compound)
```
- 方法详细资料
  - nodeCount
```
public int nodeCount()
```
    Returns the number of node in the graph.
    
    返回:
    
    int
  - getNodes
```
public Collection<String> getNodes()
```
    Get node
    
    返回:
    
    java.util.Set
  - getNode
```
public N getNode(String nodeId)
```
  - getSources
```
public Set<String> getSources()
```
    Returns those node in the graph that have no in-edge.
    
    返回:
    
    java.util.Set
  - getSinks
```
public Set<String> getSinks()
```
    Returns those node in the graph that have no out-edge.
    
    返回:
    
    java.util.Set
  - setNode
```
public Graph<N,E> setNode(String id)
```
    Creates or updates the value for the node in the graph.
    
    参数:
    
    id - node id
    
    返回:
    
    current node
  - setNode
```
public Graph<N,E> setNode(String id,
                          N n)
```
    Creates or updates the value for the node in the graph.
    
    参数:
    
    id - node id
    
    n - node data
    
    返回:
    
    current node
  - setNodes
```
public Graph<N,E> setNodes(Collection<String> nodes)
```
    Creates or updates the value for the nodes in the graph.
    
    参数:
    
    nodes - add all node
    
    返回:
    
    current graph
  - setNodes
```
public Graph<N,E> setNodes(Collection<String> nodes,
                           N n)
```
    Creates or updates the value for the nodes in the graph.
    
    参数:
    
    nodes - add all node
    
    n - data for node
    
    返回:
    
    current graph
  - hasNode
```
public boolean hasNode(String id)
```
    Returns true if the graph has a node with the id.
    
    参数:
    
    id - node id
    
    返回:
    
    boolean
  - removeNode
```
public Graph<N,E> removeNode(String id)
```
    Remove the node with the id in the graph or do nothing if the node is not in the graph.
    
    参数:
    
    id - node id
    
    返回:
    
    current graph
  - edgeCount
```
public int edgeCount()
```
    Returns the number of edges in the graph.
    
    返回:
    
    edge count
  - getEdges
```
public Collection<Edge> getEdges()
```
    Returns the Edge for each getEdge in the graph.
    
    返回:
    
    all edge's
  - getEdge
```
public E getEdge(Edge edge)
```
    参数:
    
    edge - Edge
    
    返回:
    
    edge
  - getEdge
```
public E getEdge(String sourceId,
                 String targetId)
```
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    返回:
    
    edge @Edge
  - getEdge
```
public E getEdge(String sourceId,
                 String targetId,
                 String name)
```
    get edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    name - edge name
    
    返回:
    
    edge data
  - setEdge
```
public Graph<N,E> setEdge(String sourceId,
                          String targetId)
```
    add edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    返回:
    
    current graph
  - setEdge
```
public Graph<N,E> setEdge(String sourceId,
                          String targetId,
                          E e)
```
    add edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    e - edge data
    
    返回:
    
    current graph
  - setEdge
```
public Graph<N,E> setEdge(Edge edge)
```
    add new edge
    
    参数:
    
    edge - edge
    
    返回:
    
    current graph
  - setEdge
```
public Graph<N,E> setEdge(Edge edge,
                          E e)
```
    add new edge
    
    参数:
    
    edge - edge
    
    e - edge data
    
    返回:
    
    current graph
  - setEdge
```
public Graph<N,E> setEdge(String sourceId,
                          String targetId,
                          E e,
                          String name)
```
    add new edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target ndoe id
    
    e - edge data
    
    name - edge name
    
    返回:
    
    current graph
  - hasEdge
```
public boolean hasEdge(Edge edge)
```
  - hasEdge
```
public boolean hasEdge(String sourceId,
                       String targetId)
```
  - hasEdge
```
public boolean hasEdge(String sourceId,
                       String targetId,
                       String name)
```
    exist edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    name - edge name
    
    返回:
    
    has edge
  - removeEdge
```
public Graph<N,E> removeEdge(Edge edge)
```
    remove edge
    
    参数:
    
    edge - edge
    
    返回:
    
    current graph
  - removeEdge
```
public Graph<N,E> removeEdge(String sourceId,
                             String targetId)
```
    remove edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    返回:
    
    current graph
  - removeEdge
```
public Graph<N,E> removeEdge(String sourceId,
                             String targetId,
                             String name)
```
    remove edge
    
    参数:
    
    sourceId - source node id
    
    targetId - target node id
    
    name - edge name
    
    返回:
    
    current graph
  - setPath
```
public Graph<N,E> setPath(Collection<String> path)
```
    add multi edge by path
    
    参数:
    
    path - node id collection
    
    返回:
    
    current graph
  - setPath
```
public Graph<N,E> setPath(String... nodeId)
```
    add multi edge by node id's
    
    参数:
    
    nodeId - node id
    
    返回:
    
    current graph
  - setPath
```
public Graph<N,E> setPath(Collection<String> path,
                          E e)
```
    add multi edge by node id's
    
    参数:
    
    path - node id collection
    
    e - edge data
    
    返回:
    
    current graph
  - inEdges
```
public Collection<Edge> inEdges(String nodeId)
```
  - inEdges
```
public Collection<Edge> inEdges(String nodeId,
                                String sourceId)
```
    Return all edge that point to the node v.
    
    参数:
    
    nodeId - node id
    
    sourceId - Optionally filters
    
    返回:
    
    java.util.Collection
  - outEdges
```
public Collection<Edge> outEdges(String nodeId)
```
  - outEdges
```
public Collection<Edge> outEdges(String nodeId,
                                 String targetId)
```
    Return all edge that are pointed at by node v.
    
    参数:
    
    nodeId - node id
    
    targetId - Optionally filters
    
    返回:
    
    java.util.Collection
  - nodeEdges
```
public Collection<Edge> nodeEdges(String nodeId)
```
  - nodeEdges
```
public Collection<Edge> nodeEdges(String nodeId,
                                  String connectedNodeId)
```
    Returns all edgeLabels to or from node nodeId regardless of direction.
    
    参数:
    
    nodeId - node id
    
    connectedNodeId - Optionally filters
    
    返回:
    
    edge's for node
  - predecessors
```
public Collection<String> predecessors(String nodeId)
```
    参数:
    
    nodeId - node id
    
    返回:
    
    predecessors node id
  - successors
```
public Collection<String> successors(String nodeId)
```
    参数:
    
    nodeId - node id
    
    返回:
    
    successors node id
  - neighbors
```
public Collection<String> neighbors(String nodeId)
```
    参数:
    
    nodeId - node id
    
    返回:
    
    predecessors and successors node id's
  - setParent
```
public Graph<N,E> setParent(String nodeId,
                            String parentId)
```
    参数:
    
    nodeId - node id
    
    parentId - parent node id
    
    返回:
    
    current graph
  - getParent
```
public String getParent(String nodeId)
```
  - getChildren
```
public Collection<String> getChildren(String nodeId)
```
    参数:
    
    nodeId - node id
    
    返回:
    
    children for nodeId
  - filterNodes
```
public Graph<N,E> filterNodes(Predicate<String> filter)
```
    参数:
    
    filter - node filter
    
    返回:
    
    filtered result
  - isLeaf
```
public boolean isLeaf(String nodeId)
```
    参数:
    
    nodeId - node id
    
    返回:
    
    is leaf
  - isDirected
```
public boolean isDirected()
```
    返回:
    
    is directed
  - setDirected
```
public void setDirected(boolean directed)
```
    参数:
    
    directed - set for field directed
  - isMultiGraph
```
public boolean isMultiGraph()
```
    返回:
    
    is multi graph
  - setMultiGraph
```
public void setMultiGraph(boolean multiGraph)
```
    参数:
    
    multiGraph - set for field multiGraph
  - isCompound
```
public boolean isCompound()
```
    返回:
    
    support compound
  - setCompound
```
public void setCompound(boolean compound)
```
    参数:
    
    compound - set for field compound
  - components
```
public List<Graph<N,E>> components()
```
    Finds all connected components in a graph and returns an array of these components. Each component is itself an array that contains the ids of nodes in the component. This function takes O(|V|) time.
    
    返回:
    
    all connected components
  - tarjan
```
public List<List<String>> tarjan()
```
    This function is an implementation of Tarjan's algorithm which finds all strongly connected components in the directed graph g.
    
    返回:
    
    This function returns an array of components.
  - topsort
```
public List<String> topsort()
```
    An implementation of topological sorting (https://en.wikipedia.org/wiki/Topological_sorting).
    
    返回:
    
    an array of nodes such that for each edge u -> v, u appears before v in the array.
  - isAcyclic
```
public boolean isAcyclic()
```
    This method returns true if the graph has no cycles and returns false if it does.
    
    返回:
    
    is acyclic
  - findCycles
```
public List<List<String>> findCycles()
```
    Find cycles.
    
    返回:
    
    This method returns all nodes that are part of a cycle.

类 Graph<N,E>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Graph

Graph

方法详细资料

nodeCount

getNodes

getNode

getSources

getSinks

setNode

setNode

setNodes

setNodes

hasNode

removeNode

edgeCount

getEdges

getEdge

getEdge

getEdge

setEdge

setEdge

setEdge

setEdge

setEdge

hasEdge

hasEdge

hasEdge

removeEdge

removeEdge

removeEdge

setPath

setPath

setPath

inEdges

inEdges

outEdges

outEdges

nodeEdges

nodeEdges

predecessors

successors

neighbors

setParent

getParent

getChildren

filterNodes

isLeaf

isDirected

setDirected

isMultiGraph

setMultiGraph

isCompound

setCompound

components

tarjan

topsort

isAcyclic

findCycles