Package org.evoludo.simulator

Enum Class Geometry.Type

Object

Enum<Geometry.Type>

Type

All Implemented Interfaces:

Serializable, Comparable<Geometry.Type>, Constable, CLOption.Key

Enclosing class:

Geometry

public static enum Geometry.Type
extends Enum<Geometry.Type>
implements CLOption.Key

The types of graph geometries. Currently available graph geometries are:

MEANFIELD

mean-field/well-mixed population

COMPLETE

complete graph (connectivity \(k=N-1\))

HIERARCHY

hierarchical (meta-)populations

STAR

star graph (single hub)

WHEEL

wheel (cycle with single hub)

SUPER_STAR

super-star (single hub, petals

STRONG_AMPLIFIER

strong (undirected) amplifier

STRONG_SUPPRESSOR

strong (undirected) suppressor

LINEAR

linear lattice, 1D

SQUARE_NEUMANN

square lattice, 2D (von neumann neighbourhood, nearest neighbours, connectivity \(k=4\))

SQUARE_NEUMANN_2ND

square lattice, 2D (second nearest neighbours, connectivity \(k=4\))

SQUARE_MOORE

square lattice, 2D (moore neighbourhood, first and second nearest neighbours, connectivity \(k=8\))

SQUARE

square lattice, 2D

CUBE

cubic lattice, 3D

HONEYCOMB

hexagonal/honeycomb lattice (connectivity \(k=6\))

TRIANGULAR

triangular lattice (connectivity \(k=3\))

FRUCHT

Frucht graph, \(N=12, k=3\)

TIETZE

Tietze graph \(N=12, k=3\)

FRANKLIN

Franklin graph \(N=12, k=3\)

HEAWOOD

Heawood graph \(N=14, k=3\)

ICOSAHEDRON

Icosahedron graph \(N=12, k=5\)

DODEKAHEDRON

Dodekahedron graph \(N=20, k=3\)

DESARGUES

Desargues graph \(N=20, k=3\)

RANDOM_GRAPH

random graph

RANDOM_GRAPH_DIRECTED

directed random graph

RANDOM_REGULAR_GRAPH

random regular graph

SCALEFREE

scale-free graph

SCALEFREE_BA

scale-free graph, Barabasi & Albert

SCALEFREE_KLEMM

scale-free graph, Klemm & Eguiluz

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETE	Complete graph, connectivity \(k=N-1\).
CUBE	Cubic lattice, 3D.
DESARGUES	Desargues graph, size \(N=20\), connectivity \(k=3\).
DODEKAHEDRON	Dodekahedron graph, size \(N=20\), connectivity \(k=3\).
DYNAMIC	Dynamically changeing network structure.
FRANKLIN	Franklin graph, size \(N=12\), connectivity \(k=3\).
FRUCHT	Frucht graph, size \(N=12\), connectivity \(k=3\).
GENERIC	Placeholder for generic geometry.
HEAWOOD	Heawood graph, size \(N=14\), connectivity \(k=3\).
HIERARCHY	Hierarchical (meta-)populations.
HONEYCOMB	Hexagonal (honeycomb) lattice, connectivity \(k=6\).
ICOSAHEDRON	Icosahedron graph, size \(N=12\), connectivity \(k=5\).
INVALID	Placeholder for invalid geometry.
LINEAR	Linear lattice, 1D.
MEANFIELD	Mean-field/well-mixed population.
RANDOM_GRAPH	Random graph.
RANDOM_GRAPH_DIRECTED	Directed random graph.
RANDOM_REGULAR_GRAPH	Random regular graph.
SCALEFREE	Scale-free network.
SCALEFREE_BA	Scale-free network.
SCALEFREE_KLEMM	Scale-free network.
SQUARE	Square lattice, 2D.
SQUARE_MOORE	Square lattice (Moore neighbourhood).
SQUARE_NEUMANN	Square lattice (von Neumann neighbourhood).
SQUARE_NEUMANN_2ND	Square lattice.
STAR	Star graph, connectivity \(k=2(N-1)/N\).
STRONG_AMPLIFIER	Strong (undirected) amplifier.
STRONG_SUPPRESSOR	Strong (undirected) suppressor.
SUPER_STAR	Superstar graph (single hub, petals).
TIETZE	Tietze's graph, size \(N=12\), connectivity \(k=3\).
TRIANGULAR	Triangular lattice, connectivity \(k=3\).
VOID	Placeholder for empty geometry.
WHEEL	Wheel graph, connectivity \(k=4(N-1)/N\).

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	description	Optional long description of geometry type for help display.
(package private) String	key	Key of geometry.
(package private) String	title	Brief description of geometry type for GUI and help display.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Type(String key, String title)	Instantiate new type of geometry.
private	Type(String key, String title, String description)	Instantiate new geometry type.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Optional: long description of purpose of this key.
String	getKey()	Return key of in this collection.
String	getTitle()	Brief description of purpose of this key.
boolean	isLattice()	Check if the geometry is a lattice.
boolean	isSquareLattice()	Check if the geometry is a square lattice.
String	toString()
static Geometry.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Geometry.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MEANFIELD

public static final Geometry.Type MEANFIELD

Mean-field/well-mixed population.

See Also:

• Geometry.initGeometryMeanField()

COMPLETE

public static final Geometry.Type COMPLETE

Complete graph, connectivity \(k=N-1\).

See Also:

• Geometry.initGeometryComplete()

HIERARCHY

public static final Geometry.Type HIERARCHY

Hierarchical (meta-)populations. Supported sub-population types are:

• M: well-mixed (default)
• n: square lattice (von neumann)
• m: square lattice (moore)

Append f for fixed lattice boundaries. The hierarchical populations are specified as a vector with the format <n1>[,<n2>[...,<nm>]]w where ni refers to the number of units in level i. There is a total of m+1 levels with nPopulation/(n1*...*nm) individuals in the last level (smallest unit). The strength of interaction between levels is w.

See Also:

• Geometry.initGeometryHierarchical()

LINEAR

public static final Geometry.Type LINEAR

Linear lattice, 1D. l<l>[,<r>] specifies a linear lattice with l neighbours to the left and r to the right. If r is missing or r==l the neighbourhood is symmetric.

See Also:

• Geometry.initGeometryLinear()

SQUARE_NEUMANN

public static final Geometry.Type SQUARE_NEUMANN

Square lattice (von Neumann neighbourhood). Four nearest neighbours (north, east, south, west).

See Also:

• Geometry.initGeometrySquare()
• Geometry.initGeometrySquareVonNeumann(int, int, int)

SQUARE_NEUMANN_2ND

public static final Geometry.Type SQUARE_NEUMANN_2ND

Square lattice. Four second-nearest neighbours (north-east, north-west, south-west, south-east).

See Also:

• Geometry.initGeometrySquare()
• Geometry.initGeometrySquareVonNeumann2nd(int, int, int)

SQUARE_MOORE

public static final Geometry.Type SQUARE_MOORE

Square lattice (Moore neighbourhood). Eight nearest neighbours (chess kings moves).

See Also:

• Geometry.initGeometrySquare()
• Geometry.initGeometrySquareMoore(int, int, int)

SQUARE

public static final Geometry.Type SQUARE

Square lattice, 2D. N<n> specifies a square lattice with n neighbours, where n is 3x3, 5x5....

See Also:

• Geometry.initGeometrySquare()
• Geometry.initGeometrySquare(int, int, int)

CUBE

public static final Geometry.Type CUBE

Cubic lattice, 3D. C<n> cubic lattice with n neighbours, where n is 2+2+2, 3x3x3, 5x5x5....

See Also:

• Geometry.initGeometryCube()

HONEYCOMB

public static final Geometry.Type HONEYCOMB

Hexagonal (honeycomb) lattice, connectivity \(k=6\).

See Also:

• Geometry.initGeometryHoneycomb()

TRIANGULAR

public static final Geometry.Type TRIANGULAR

Triangular lattice, connectivity \(k=3\).

See Also:

• Geometry.initGeometryTriangular()

FRUCHT

public static final Geometry.Type FRUCHT

Frucht graph, size \(N=12\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryFruchtGraph()

TIETZE

public static final Geometry.Type TIETZE

Tietze's graph, size \(N=12\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryTietzeGraph()

FRANKLIN

public static final Geometry.Type FRANKLIN

Franklin graph, size \(N=12\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryFranklinGraph()

HEAWOOD

public static final Geometry.Type HEAWOOD

Heawood graph, size \(N=14\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryHeawoodGraph()

ICOSAHEDRON

public static final Geometry.Type ICOSAHEDRON

Icosahedron graph, size \(N=12\), connectivity \(k=5\).

See Also:

• Geometry.initGeometryIcosahedronGraph()

DODEKAHEDRON

public static final Geometry.Type DODEKAHEDRON

Dodekahedron graph, size \(N=20\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryDodekahedronGraph()

DESARGUES

public static final Geometry.Type DESARGUES

Desargues graph, size \(N=20\), connectivity \(k=3\).

See Also:

• Geometry.initGeometryDesarguesGraph()

STAR

public static final Geometry.Type STAR

Star graph, connectivity \(k=2(N-1)/N\).

See Also:

• Geometry.initGeometryStar()

SUPER_STAR

public static final Geometry.Type SUPER_STAR

Superstar graph (single hub, petals). S<p[,k]> superstar graph with p petals and amplification k.

See Also:

• Geometry.initGeometrySuperstar()

WHEEL

public static final Geometry.Type WHEEL

Wheel graph, connectivity \(k=4(N-1)/N\).

See Also:

• Geometry.initGeometryWheel()

STRONG_AMPLIFIER

public static final Geometry.Type STRONG_AMPLIFIER

Strong (undirected) amplifier.

See Also:

• Geometry.initGeometryAmplifier()

STRONG_SUPPRESSOR

public static final Geometry.Type STRONG_SUPPRESSOR

Strong (undirected) suppressor.

See Also:

• Geometry.initGeometrySuppressor()

RANDOM_REGULAR_GRAPH

public static final Geometry.Type RANDOM_REGULAR_GRAPH

Random regular graph.

See Also:

• Geometry.initGeometryRandomRegularGraph()

RANDOM_GRAPH

public static final Geometry.Type RANDOM_GRAPH

Random graph. R<d> random graph with degree d.

See Also:

• Geometry.initGeometryRandomGraph()

RANDOM_GRAPH_DIRECTED

public static final Geometry.Type RANDOM_GRAPH_DIRECTED

Directed random graph. D<d> random graph with degree d.

See Also:

• Geometry.initGeometryRandomGraphDirected()

SCALEFREE

public static final Geometry.Type SCALEFREE

Scale-free network. p<e> scale-free network with exponent e.

See Also:

• Geometry.initGeometryScaleFree()

SCALEFREE_KLEMM

public static final Geometry.Type SCALEFREE_KLEMM

Scale-free network. F<n[,p]> scale-free network with degree n and a fraction of p random links.

See Also:

• Geometry.initGeometryScaleFreeKlemm()

SCALEFREE_BA

public static final Geometry.Type SCALEFREE_BA

Scale-free network. f<d> scale-free network with degree d.

See Also:

• Geometry.initGeometryScaleFreeBA()

DYNAMIC

public static final Geometry.Type DYNAMIC

Dynamically changeing network structure.

See Also:

• Geometry.initGeometryScaleFreeBA()

VOID

public static final Geometry.Type VOID

Placeholder for empty geometry. Not user selectable.

GENERIC

public static final Geometry.Type GENERIC

Placeholder for generic geometry. Not user selectable.

INVALID

public static final Geometry.Type INVALID

Placeholder for invalid geometry. Not user selectable.

Field Details

key

String key

Key of geometry. Used for parsing command line options.

See Also:

• Module.cloGeometry
• IBS.cloGeometryInteraction
• IBS.cloGeometryCompetition

title

String title

Brief description of geometry type for GUI and help display.

See Also:

• EvoLudo.getCLOHelp()

description

String description

Optional long description of geometry type for help display.

See Also:

• EvoLudo.getCLOHelp()

Constructor Details

Type

private Type(String key,
 String title)

Instantiate new type of geometry.

Parameters:

key - identifier for parsing of command line option

title - the summary of geometry for GUI and help display

Type

private Type(String key,
 String title,
 String description)

Instantiate new geometry type.

Parameters:

key - the identifier for parsing of command line options

title - the summary of the geometry for GUI and help display

description - the optional description of geometry

Method Details

values

public static Geometry.Type[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Geometry.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Description copied from interface: CLOption.Key

Return key of in this collection. Used when parsing command line options.

Specified by:

getKey in interface CLOption.Key

Returns:

the key of the command line option

getTitle

public String getTitle()

Description copied from interface: CLOption.Key

Brief description of purpose of this key. Used in GUI and in help display.

Specified by:

getTitle in interface CLOption.Key

Returns:

the title of the command line option

See Also:

• EvoLudo.showHelp()

getDescription

public String getDescription()

Description copied from interface: CLOption.Key

Optional: long description of purpose of this key. Used in help display. Defaults to brief description.

Specified by:

getDescription in interface CLOption.Key

Returns:

the description of the command line option

See Also:

• CLOption.Key.getTitle()
• EvoLudo.showHelp()

isSquareLattice

public boolean isSquareLattice()

Check if the geometry is a square lattice.

Returns:

true if the geometry is a square lattice

isLattice

public boolean isLattice()

Check if the geometry is a lattice.

Returns:

true if the geometry is a lattice

toString

public String toString()

Overrides:

toString in class Enum<Geometry.Type>