org.spectrumauctions.sats.core.model.mrvm

Class MRVMRegionsMap

java.lang.Object

org.spectrumauctions.sats.core.model.mrvm.MRVMRegionsMap

All Implemented Interfaces:

Serializable

public class MRVMRegionsMap
extends Object
implements Serializable

Author:

Michael Weiss

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MRVMRegionsMap.Region

Constructor Summary

Constructors

Constructor and Description
MRVMRegionsMap(MRVMWorldSetup worldStructure, RNGSupplier rngSupplier)

Method Summary

Modifier and Type	Method and Description
Set<MRVMRegionsMap.Region>	adjacentRegions(MRVMRegionsMap.Region region)
boolean	areAdjacent(MRVMRegionsMap.Region region, MRVMRegionsMap.Region otherRegion)
boolean	equals(Object obj)
int	getDistance(MRVMRegionsMap.Region regionOne, MRVMRegionsMap.Region regionTwo) Calculates the distance between two regions in this map. Distance is defined as the length of the shortest path in a graph representation of this map, where two regions share an edge if and only if they are adjacent.
int	getLongestShortestPath(MRVMRegionsMap.Region region) Returns the length of the longest shortest path in the adjacency graph between the specified region and any other region.
int	getNumberOfRegions()
MRVMRegionsMap.Region	getRegion(int id)
Set<MRVMRegionsMap.Region>	getRegions()
protected org.jgrapht.graph.UnmodifiableGraph<MRVMRegionsMap.Region,org.jgrapht.graph.DefaultEdge>	getSubgraph(Set<MRVMRegionsMap.Region> regions) Creates a new, unmodifiable regions-graph, consistent with the adjacency graph of this map, but only containing the specified set of regions as vertices.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

MRVMRegionsMap

public MRVMRegionsMap(MRVMWorldSetup worldStructure,
                      RNGSupplier rngSupplier)

Method Detail

getLongestShortestPath

public int getLongestShortestPath(MRVMRegionsMap.Region region)

Returns the length of the longest shortest path in the adjacency graph between the specified region and any other region.

adjacentRegions

public Set<MRVMRegionsMap.Region> adjacentRegions(MRVMRegionsMap.Region region)

getSubgraph

protected org.jgrapht.graph.UnmodifiableGraph<MRVMRegionsMap.Region,org.jgrapht.graph.DefaultEdge> getSubgraph(Set<MRVMRegionsMap.Region> regions)

Creates a new, unmodifiable regions-graph, consistent with the adjacency graph of this map, but only containing the specified set of regions as vertices. Note: The Region Instances are not copied, hence, calling getDistance(Region, Region), adjacentRegions(Region) and similar methods on the regions in the returned graph will return the values w.r.t. the original graph in the map.

areAdjacent

public boolean areAdjacent(MRVMRegionsMap.Region region,
                           MRVMRegionsMap.Region otherRegion)

Returns:

true if two regions is adjacent, i.e., if they share a border.

getDistance

public int getDistance(MRVMRegionsMap.Region regionOne,
                       MRVMRegionsMap.Region regionTwo)

Calculates the distance between two regions in this map.

Distance is defined as the length of the shortest path in a graph representation of this map, where two regions share an edge if and only if they are adjacent. All edges have weight / lenght 1.
If no path was found, getNumberOfRegions()-1 is returned.

getRegions

public Set<MRVMRegionsMap.Region> getRegions()

getNumberOfRegions

public int getNumberOfRegions()

getRegion

public MRVMRegionsMap.Region getRegion(int id)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object