edu.stanford.multiagent.gamer.graphs
Class NDimensionalWrappedGrid

java.lang.Object
  |
  +--edu.stanford.multiagent.gamer.ParameterizedObject
        |
        +--edu.stanford.multiagent.gamer.graphs.Graph
              |
              +--edu.stanford.multiagent.gamer.graphs.ALGraph
                    |
                    +--edu.stanford.multiagent.gamer.graphs.NDimensionalGrid
                          |
                          +--edu.stanford.multiagent.gamer.graphs.NDimensionalWrappedGrid

public class NDimensionalWrappedGrid
extends NDimensionalGrid

Generates a graph on an n-dimensional grid that wraps around at the edges, i.e. 1D is a ring, 2D is a torus, and so on. Currently all dimensions are the same length to keep parameterization from getting out of hand. NDimensionalWrappedGrid is built as a subclass of NDimensionalGrid as it uses many of the same functions (initialize, checkParameters, translateIndices, etc.) but more edges are generated.


Field Summary
 
Fields inherited from class edu.stanford.multiagent.gamer.graphs.NDimensionalGrid
ndgParam, pDimSize, pN
 
Fields inherited from class edu.stanford.multiagent.gamer.graphs.ALGraph
nodes
 
Fields inherited from class edu.stanford.multiagent.gamer.graphs.Graph
nEdges, nNodes, nodeData, pReflexEdges, pSymEdges
 
Fields inherited from class edu.stanford.multiagent.gamer.ParameterizedObject
parameters
 
Constructor Summary
NDimensionalWrappedGrid()
           
 
Method Summary
 void doGenerate()
          Generate an N-dimensional grid graph
protected  java.lang.String getGraphHelp()
          Returns a help information string about the particular graph, does not include parameter information.
 
Methods inherited from class edu.stanford.multiagent.gamer.graphs.NDimensionalGrid
checkParameters, hasSymEdges, initialize, randomizeParameters, reflexEdgesOk, translateIndices
 
Methods inherited from class edu.stanford.multiagent.gamer.graphs.ALGraph
addEdge, addEdge, addNode, areNeighbours, getEdge, getEdges, getNeighbours, getNumNeighbours, removeEdge, removeEdge, setEdgeData
 
Methods inherited from class edu.stanford.multiagent.gamer.graphs.Graph
getHelp, getNEdges, getNNodes, getNodeData, setNodeData
 
Methods inherited from class edu.stanford.multiagent.gamer.ParameterizedObject
getBooleanParameter, getDescription, getDoubleParameter, getLongParameter, getParamDescription, getParameter, getParameters, getStringParameter, setParameter, setParameter, setParameters, setParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NDimensionalWrappedGrid

public NDimensionalWrappedGrid()
                        throws java.lang.Exception
Method Detail

getGraphHelp

protected java.lang.String getGraphHelp()
Description copied from class: Graph
Returns a help information string about the particular graph, does not include parameter information.

Overrides:
getGraphHelp in class NDimensionalGrid

doGenerate

public void doGenerate()
Description copied from class: NDimensionalGrid
Generate an N-dimensional grid graph

Overrides:
doGenerate in class NDimensionalGrid