org.jgrapht.io

Class Graph6Sparse6Importer<V,E>

java.lang.Object

org.jgrapht.io.Graph6Sparse6Importer<V,E>

Type Parameters:

V - graph vertex type

E - graph edge type

All Implemented Interfaces:

GraphImporter<V,E>

public class Graph6Sparse6Importer<V,E>
extends Object
implements GraphImporter<V,E>

Importer which reads graphs in graph6 or sparse6 format. A description of the format can be found here. graph6 and sparse6 are formats for storing undirected graphs in a compact manner, using only printable ASCII characters. Files in these formats have text Format and contain one line per graph. graph6 is suitable for small graphs, or large dense graphs. sparse6 is more space-efficient for large sparse graphs. Typically, files storing graph6 graphs have the 'g6' extension. Similarly, files storing sparse6 graphs have a 's6' file extension. sparse6 graphs support loops and multiple edges, graph6 graphs do not.

Author:

Joris Kinable

Field Summary

Fields

Modifier and Type	Field and Description
protected EdgeProvider<V,E>	edgeProvider Constructs new edges
protected ComponentUpdater<Graph<V,E>>	graphUpdater Updates graph properties
protected VertexProvider<V>	vertexProvider Constructs new vertices
protected ComponentUpdater<V>	vertexUpdater Updates already constructed vertices

Constructor Summary

Constructors

Constructor and Description
Graph6Sparse6Importer(VertexProvider<V> vertexProvider, EdgeProvider<V,E> edgeProvider) Construct a new Graph6Sparse6Importer
Graph6Sparse6Importer(VertexProvider<V> vertexProvider, EdgeProvider<V,E> edgeProvider, double defaultWeight) Construct a new Graph6Sparse6Importer

Method Summary

Modifier and Type	Method and Description
EdgeProvider<V,E>	getEdgeProvider() Get the edge provider
ComponentUpdater<Graph<V,E>>	getGraphUpdater() Get the graph updater.
VertexProvider<V>	getVertexProvider() Get the vertex provider
ComponentUpdater<V>	getVertexUpdater() Get the vertex updater
void	importGraph(Graph<V,E> g, Reader input) Import a graph
void	importGraph(Graph<V,E> g, String g6) Import the graph represented by a String in graph6 or sparse6 encoding.
void	setEdgeProvider(EdgeProvider<V,E> edgeProvider) Set the edge provider.
void	setGraphUpdater(ComponentUpdater<Graph<V,E>> graphUpdater) Set the graph updater.
void	setVertexProvider(VertexProvider<V> vertexProvider) Set the vertex provider
void	setVertexUpdater(ComponentUpdater<V> vertexUpdater) Set the vertex updater.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jgrapht.io.GraphImporter

importGraph, importGraph

Field Detail

vertexProvider

protected VertexProvider<V> vertexProvider

Constructs new vertices

edgeProvider

protected EdgeProvider<V,E> edgeProvider

Constructs new edges

vertexUpdater

protected ComponentUpdater<V> vertexUpdater

Updates already constructed vertices

graphUpdater

protected ComponentUpdater<Graph<V,E>> graphUpdater

Updates graph properties

Constructor Detail

Graph6Sparse6Importer

public Graph6Sparse6Importer(VertexProvider<V> vertexProvider,
                             EdgeProvider<V,E> edgeProvider,
                             double defaultWeight)

Construct a new Graph6Sparse6Importer

Parameters:

vertexProvider - provider for the generation of vertices. Must not be null.

edgeProvider - provider for the generation of edges. Must not be null.

defaultWeight - default edge weight

Graph6Sparse6Importer

public Graph6Sparse6Importer(VertexProvider<V> vertexProvider,
                             EdgeProvider<V,E> edgeProvider)

Construct a new Graph6Sparse6Importer

Parameters:

vertexProvider - provider for the generation of vertices. Must not be null.

edgeProvider - provider for the generation of edges. Must not be null.

Method Detail

importGraph

public void importGraph(Graph<V,E> g,
                        Reader input)
                 throws ImportException

Description copied from interface: GraphImporter

Import a graph

Specified by:

importGraph in interface GraphImporter<V,E>

Parameters:

g - the graph

input - the input reader

Throws:

ImportException - in case any error occurs, such as I/O or parse error

importGraph

public void importGraph(Graph<V,E> g,
                        String g6)
                 throws ImportException

Import the graph represented by a String in graph6 or sparse6 encoding.

Parameters:

g - the graph

g6 - String representation of a graph either in graph6 or sparse6 format. WARNING: a g6/s6 string may contain backslashes '\'. Escaping is required when invoking this method directly. E.g.

 importgraph(g,":?@MnDA\oi")
        

may result in undefined behavior. This should have been:

 importgraph(g,":?@MnDA\\oi")
        

Throws:

ImportException - in case any error occurs, such as I/O or parse error

getVertexProvider

public VertexProvider<V> getVertexProvider()

Get the vertex provider

Returns:

the vertex provider

setVertexProvider

public void setVertexProvider(VertexProvider<V> vertexProvider)

Set the vertex provider

Parameters:

vertexProvider - the new vertex provider. Must not be null.

getEdgeProvider

public EdgeProvider<V,E> getEdgeProvider()

Get the edge provider

Returns:

The edge provider

setEdgeProvider

public void setEdgeProvider(EdgeProvider<V,E> edgeProvider)

Set the edge provider.

Parameters:

edgeProvider - the new edge provider. Must not be null.

getVertexUpdater

public ComponentUpdater<V> getVertexUpdater()

Get the vertex updater

Returns:

the vertex updater

setVertexUpdater

public void setVertexUpdater(ComponentUpdater<V> vertexUpdater)

Set the vertex updater.

Parameters:

vertexUpdater - the new vertex updater. Must not be null.

getGraphUpdater

public ComponentUpdater<Graph<V,E>> getGraphUpdater()

Get the graph updater.

Returns:

the graph updater

setGraphUpdater

public void setGraphUpdater(ComponentUpdater<Graph<V,E>> graphUpdater)

Set the graph updater.

Parameters:

graphUpdater - the new graph updater. Must not be null.