org.jgrapht.ext

Class MatrixExporter<V,E>

java.lang.Object

org.jgrapht.ext.MatrixExporter<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphExporter<V,E>

public class MatrixExporter<V,E>
extends Object
implements GraphExporter<V,E>

Exports a graph to a plain text matrix format, which can be processed by matrix manipulation software, such as MTJ or MATLAB.

The exporter supports three different formats, see MatrixExporter.Format.

Author:

Charles Fry, Dimitrios Michail

See Also:

MatrixExporter.Format

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatrixExporter.Format Formats supported by the exporter.

Constructor Summary

Constructors

Constructor and Description
MatrixExporter() Creates a new MatrixExporter with integer name provider for the vertex identifiers and MatrixExporter.Format.SPARSE_ADJACENCY_MATRIX as the default format.
MatrixExporter(MatrixExporter.Format format) Creates a new MatrixExporter with integer name provider for the vertex identifiers.
MatrixExporter(MatrixExporter.Format format, VertexNameProvider<V> vertexIDProvider) Creates a new MatrixExporter.

Method Summary

Modifier and Type	Method and Description
void	exportAdjacencyMatrix(Writer output, DirectedGraph<V,E> g) Deprecated.
void	exportAdjacencyMatrix(Writer output, UndirectedGraph<V,E> g) Deprecated.
void	exportGraph(Graph<V,E> g, Writer writer) Export a graph
void	exportLaplacianMatrix(Writer output, UndirectedGraph<V,E> g) Deprecated.
void	exportNormalizedLaplacianMatrix(Writer output, UndirectedGraph<V,E> g) Deprecated.
MatrixExporter.Format	getFormat() Get the format that the exporter is using.
void	setFormat(MatrixExporter.Format format) Set the output format of the exporter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.ext.GraphExporter

exportGraph, exportGraph

Constructor Detail

MatrixExporter

public MatrixExporter()

Creates a new MatrixExporter with integer name provider for the vertex identifiers and MatrixExporter.Format.SPARSE_ADJACENCY_MATRIX as the default format.

MatrixExporter

public MatrixExporter(MatrixExporter.Format format)

Creates a new MatrixExporter with integer name provider for the vertex identifiers.

Parameters:

format - format to use

MatrixExporter

public MatrixExporter(MatrixExporter.Format format,
                      VertexNameProvider<V> vertexIDProvider)

Creates a new MatrixExporter.

Parameters:

format - format to use

vertexIDProvider - for generating vertex identifiers. Must not be null.

Method Detail

getFormat

public MatrixExporter.Format getFormat()

Get the format that the exporter is using.

Returns:

the output format

setFormat

public void setFormat(MatrixExporter.Format format)

Set the output format of the exporter

Parameters:

format - the format to use

exportGraph

public void exportGraph(Graph<V,E> g,
                        Writer writer)
                 throws ExportException

Description copied from interface: GraphExporter

Export a graph

Specified by:

exportGraph in interface GraphExporter<V,E>

Parameters:

g - the graph to export

writer - the output writer

Throws:

ExportException - in case any error occurs

exportAdjacencyMatrix

@Deprecated
public void exportAdjacencyMatrix(Writer output,
                                              UndirectedGraph<V,E> g)

Deprecated.

Exports the specified graph into a plain text file format containing a sparse representation of the graph's adjacency matrix. The value stored in each position of the matrix indicates the number of edges between two vertices. With an undirected graph, the adjacency matrix is symmetric.

Parameters:

output - the writer to which the graph to be exported.

g - the graph to be exported.

exportAdjacencyMatrix

@Deprecated
public void exportAdjacencyMatrix(Writer output,
                                              DirectedGraph<V,E> g)

Deprecated.

Exports the specified graph into a plain text file format containing a sparse representation of the graph's adjacency matrix. The value stored in each position of the matrix indicates the number of directed edges going from one vertex to another.

Parameters:

output - the writer to which the graph to be exported.

g - the graph to be exported.

exportLaplacianMatrix

@Deprecated
public void exportLaplacianMatrix(Writer output,
                                              UndirectedGraph<V,E> g)

Deprecated.

Exports the specified graph into a plain text file format containing a sparse representation of the graph's Laplacian matrix. Laplacian matrices are only defined for simple graphs, so edge direction, multiple edges, loops, and weights are all ignored when creating the Laplacian matrix. If you're unsure about Laplacian matrices, see: http:// mathworld.wolfram.com/LaplacianMatrix.html.

Parameters:

output - the writer to which the graph is to be exported.

g - the graph to be exported.

exportNormalizedLaplacianMatrix

@Deprecated
public void exportNormalizedLaplacianMatrix(Writer output,
                                                        UndirectedGraph<V,E> g)

Deprecated.

Exports the specified graph into a plain text file format containing a sparse representation of the graph's normalized Laplacian matrix. Laplacian matrices are only defined for simple graphs, so edge direction, multiple edges, loops, and weights are all ignored when creating the Laplacian matrix. If you're unsure about normalized Laplacian matrices, see: http:// mathworld.wolfram.com/LaplacianMatrix.html.

Parameters:

output - the writer to which the graph is to be exported.

g - the graph to be exported.