org.graphstream.graph.implementations

Class AdjacencyListGraph

java.lang.Object

org.graphstream.graph.implementations.AbstractElement

org.graphstream.graph.implementations.AbstractGraph

org.graphstream.graph.implementations.AdjacencyListGraph

All Implemented Interfaces:

java.lang.Iterable<Node>, Element, Graph, Structure, AttributeSink, ElementSink, Pipe, Replayable, Sink, Source

Direct Known Subclasses:

MultiGraph, SingleGraph

public class AdjacencyListGraph
extends AbstractGraph

A lightweight graph class intended to allow the construction of big graphs (millions of elements).

The main purpose here is to minimize memory consumption even if the management of such a graph implies more CPU consuming. See the complexity tags on each method so as to figure out the impact on the CPU.

Nested Class Summary

Nested classes/interfaces inherited from class org.graphstream.graph.implementations.AbstractElement

AbstractElement.AttributeChangeEvent

Nested classes/interfaces inherited from interface org.graphstream.stream.Replayable

Replayable.Controller

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EDGE_CAPACITY
static int	DEFAULT_NODE_CAPACITY
static double	GROW_FACTOR

Constructor Summary

Constructors

Constructor and Description
AdjacencyListGraph(java.lang.String id) Creates an empty graph with strict checking and without auto-creation.
AdjacencyListGraph(java.lang.String id, boolean strictChecking, boolean autoCreate) Creates an empty graph with default edge and node capacity.
AdjacencyListGraph(java.lang.String id, boolean strictChecking, boolean autoCreate, int initialNodeCapacity, int initialEdgeCapacity) Creates an empty graph.

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<Edge>	edges()
Edge	getEdge(int index) Get an edge by its index.
Edge	getEdge(java.lang.String id) Get an edge by its identifier.
int	getEdgeCount() Number of edges in this graph.
Node	getNode(int index) Get a node by its index.
Node	getNode(java.lang.String id) Get a node by its identifier.
int	getNodeCount() Number of nodes in this graph.
java.util.stream.Stream<Node>	nodes()

Methods inherited from class org.graphstream.graph.implementations.AbstractGraph

addAttributeSink, addEdge, addElementSink, addNode, addSink, attributeSinks, clear, clearAttributeSinks, clearElementSinks, clearSinks, display, display, edgeAdded, edgeAttributeAdded, edgeAttributeChanged, edgeAttributeRemoved, edgeFactory, edgeRemoved, elementSinks, getReplayController, getStep, graphAttributeAdded, graphAttributeChanged, graphAttributeRemoved, graphCleared, isAutoCreationEnabled, isStrict, iterator, nodeAdded, nodeAttributeAdded, nodeAttributeChanged, nodeAttributeRemoved, nodeFactory, nodeRemoved, removeAttributeSink, removeEdge, removeEdge, removeElementSink, removeNode, removeSink, setAutoCreate, setEdgeFactory, setNodeFactory, setStrict, stepBegins, stepBegins

Methods inherited from class org.graphstream.graph.implementations.AbstractElement

attributeKeys, clearAttributes, getAttribute, getAttribute, getAttributeCount, getFirstAttributeOf, getFirstAttributeOf, getId, getIndex, hasAttribute, hasAttribute, removeAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graphstream.graph.Graph

addEdge, addEdge, addEdge, addEdge, addEdge, read, read, removeEdge, removeEdge, removeEdge, removeEdge, removeNode, removeNode, write, write

Methods inherited from interface org.graphstream.graph.Element

attributeKeys, clearAttributes, getArray, getAttribute, getAttribute, getAttributeCount, getFirstAttributeOf, getFirstAttributeOf, getId, getIndex, getLabel, getMap, getNumber, getVector, hasArray, hasAttribute, hasAttribute, hasLabel, hasMap, hasNumber, hasVector, removeAttribute, setAttribute, setAttributes

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.graphstream.stream.Replayable

replay, tryReplay

Field Detail

GROW_FACTOR

public static final double GROW_FACTOR

See Also:

Constant Field Values

DEFAULT_NODE_CAPACITY

public static final int DEFAULT_NODE_CAPACITY

See Also:

Constant Field Values

DEFAULT_EDGE_CAPACITY

public static final int DEFAULT_EDGE_CAPACITY

See Also:

Constant Field Values

Constructor Detail

AdjacencyListGraph

public AdjacencyListGraph(java.lang.String id,
                          boolean strictChecking,
                          boolean autoCreate,
                          int initialNodeCapacity,
                          int initialEdgeCapacity)

Creates an empty graph.

Parameters:

id - Unique identifier of the graph.

strictChecking - If true any non-fatal error throws an exception.

autoCreate - If true (and strict checking is false), nodes are automatically created when referenced when creating a edge, even if not yet inserted in the graph.

initialNodeCapacity - Initial capacity of the node storage data structures. Use this if you know the approximate maximum number of nodes of the graph. The graph can grow beyond this limit, but storage reallocation is expensive operation.

initialEdgeCapacity - Initial capacity of the edge storage data structures. Use this if you know the approximate maximum number of edges of the graph. The graph can grow beyond this limit, but storage reallocation is expensive operation.

AdjacencyListGraph

public AdjacencyListGraph(java.lang.String id,
                          boolean strictChecking,
                          boolean autoCreate)

Creates an empty graph with default edge and node capacity.

Parameters:

id - Unique identifier of the graph.

strictChecking - If true any non-fatal error throws an exception.

autoCreate - If true (and strict checking is false), nodes are automatically created when referenced when creating a edge, even if not yet inserted in the graph.

AdjacencyListGraph

public AdjacencyListGraph(java.lang.String id)

Creates an empty graph with strict checking and without auto-creation.

Parameters:

id - Unique identifier of the graph.

Method Detail

nodes

public java.util.stream.Stream<Node> nodes()

edges

public java.util.stream.Stream<Edge> edges()

getEdge

public Edge getEdge(java.lang.String id)

Description copied from interface: Graph

Get an edge by its identifier. This method is implicitly generic and returns something which extends Edge. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedEdge edge = graph.getEdge("...");
 

the method will return an ExtendedEdge edge. If no left part exists, method will just return an Edge.

Parameters:

id - Identifier of the edge to find.

Returns:

The searched edge or null if not found.

getEdge

public Edge getEdge(int index)

Description copied from interface: Graph

Get an edge by its index. This method is implicitly generic and returns something which extends Edge. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedEdge edge = graph.getEdge(index);
 

the method will return an ExtendedEdge edge. If no left part exists, method will just return an Edge.

Parameters:

index - The index of the edge to find.

Returns:

The edge with the given index

getEdgeCount

public int getEdgeCount()

Description copied from interface: Structure

Number of edges in this graph.

Returns:

The number of edges.

getNode

public Node getNode(java.lang.String id)

Description copied from interface: Graph

Get a node by its identifier. This method is implicitly generic and returns something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode node = graph.getNode("...");
 

the method will return an ExtendedNode node. If no left part exists, method will just return a Node.

Parameters:

id - Identifier of the node to find.

Returns:

The searched node or null if not found.

getNode

public Node getNode(int index)

Description copied from interface: Graph

Get a node by its index. This method is implicitly generic and returns something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode node = graph.getNode(index);
 

the method will return an ExtendedNode node. If no left part exists, method will just return a Node.

Parameters:

index - Index of the node to find.

Returns:

The node with the given index

getNodeCount

public int getNodeCount()

Description copied from interface: Structure

Number of nodes in this graph.

Returns:

The number of nodes.