nl.cwts.networkanalysis

Class Layout

java.lang.Object

nl.cwts.networkanalysis.Layout

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Layout
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Layout of the nodes in a network.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double[][]	coordinates Coordinates of each node.
protected int	nNodes Number of nodes.

Constructor Summary

Constructors

Constructor and Description
Layout(double[][] coordinates) Constructs a layout using specified coordinates for each node.
Layout(int nNodes) Constructs a random layout for a specified number of nodes.
Layout(int nNodes, java.util.Random random) Constructs a random layout for a specified number of nodes.

Method Summary

Modifier and Type	Method and Description
Layout	clone() Clones the layout.
void	flip(int dimension) Flips a layout.
double	getAverageDistance() Returns the average distance between all pairs of nodes.
double[][]	getCoordinates() Returns the coordinates of each node.
double[]	getCoordinates(int node) Returns the coordinates of a node.
double[]	getMaxCoordinates() Returns the maximum of the coordinates of all node.
double[]	getMinCoordinates() Returns the minimum of the coordinates of all node.
int	getNNodes() Returns the number of nodes.
void	initRandomCoordinates() Initializes a random layout.
void	initRandomCoordinates(java.util.Random random) Initializes a random layout.
static Layout	load(java.lang.String fileName) Loads a layout from a file.
void	rotate(double angle) Rotates a layout.
void	save(java.lang.String fileName) Saves the layout in a file.
void	setCoordinates(int node, double[] coordinates) Positions a node at coordinates.
void	standardize(boolean standardizeDistances) Standardizes a layout.

Methods inherited from class java.lang.Object

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

Field Detail

nNodes

protected int nNodes

Number of nodes.

coordinates

protected double[][] coordinates

Coordinates of each node.

Constructor Detail

Layout

public Layout(int nNodes)

Constructs a random layout for a specified number of nodes.

Parameters:

nNodes - Number of nodes

Layout

public Layout(int nNodes,
              java.util.Random random)

Constructs a random layout for a specified number of nodes.

Parameters:

nNodes - Number of nodes

random - Random number generator

Layout

public Layout(double[][] coordinates)

Constructs a layout using specified coordinates for each node.

Parameters:

coordinates - Coordinates of each node

Method Detail

load

public static Layout load(java.lang.String fileName)
                   throws java.lang.ClassNotFoundException,
                          java.io.IOException

Loads a layout from a file.

Parameters:

fileName - File from which a layout is loaded

Returns:

Loaded layout

Throws:

java.lang.ClassNotFoundException - Class not found

java.io.IOException - Could not read the file

See Also:

save(String fileName)

clone

public Layout clone()

Clones the layout.

Overrides:

clone in class java.lang.Object

Returns:

Cloned layout

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Saves the layout in a file.

Parameters:

fileName - File in which the layout is saved

Throws:

java.io.IOException - Could not write to the file

See Also:

load(String fileName)

getNNodes

public int getNNodes()

Returns the number of nodes.

Returns:

Number of nodes

getCoordinates

public double[][] getCoordinates()

Returns the coordinates of each node.

Returns:

Coordinates of each node

getCoordinates

public double[] getCoordinates(int node)

Returns the coordinates of a node.

Parameters:

node - Node

Returns:

Coordinates

getMinCoordinates

public double[] getMinCoordinates()

Returns the minimum of the coordinates of all node.

Returns:

Minimum coordinates

getMaxCoordinates

public double[] getMaxCoordinates()

Returns the maximum of the coordinates of all node.

Returns:

Maximum coordinates

getAverageDistance

public double getAverageDistance()

Returns the average distance between all pairs of nodes.

Returns:

Average distance

setCoordinates

public void setCoordinates(int node,
                           double[] coordinates)

Positions a node at coordinates.

Parameters:

node - Node

coordinates - Coordinates

initRandomCoordinates

public void initRandomCoordinates()

Initializes a random layout.

Each node is positioned at random coordinates.

initRandomCoordinates

public void initRandomCoordinates(java.util.Random random)

Initializes a random layout.

Each node is positioned at random coordinates.

Parameters:

random - Random number generator

standardize

public void standardize(boolean standardizeDistances)

Standardizes a layout.

Standardization involves translation, rotation, reflection, and optionally dilation. The layout is translated so that it is centered at the origin. The layout is rotated so that the variance in the horizontal dimension is maximized. The layout is reflected so that in both the horizontal and the vertical dimension the median of the coordinates is non-positive. If standardizeDistances = true, the layout is dilated so that the average distance between nodes equals one.

Parameters:

standardizeDistances - Standardize distances

rotate

public void rotate(double angle)

Rotates a layout.

Parameters:

angle - Angle

flip

public void flip(int dimension)

Flips a layout.

Parameters:

dimension - Dimension