edu.stanford.multiagent.gamer.graphs
Class NAryTree

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.NAryTree

public class NAryTree

extends ALGraph

Generates an N-ary tree with a given N and a given depth.

Field Summary

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

NAryTree()
Constructor.

Method Summary

protected void	checkParameters() Makes sure that the parameters are in the proper range
void	doGenerate() Generates the N-ary tree of the given depth
protected java.lang.String	getGraphHelp() Returns a help information string about the particular graph, does not include parameter information.
boolean	hasSymEdges() It is always the case in N-Ary tree that for every edge a to b there is also an edge b to a.
void	initialize() Calls graph initialize and also set up the nodes Vector if it has not yet been set up
void	randomizeParameters() Reset the range of the number of nodes and randomize
boolean	reflexEdgesOk() It is never the case in N-ary trees that reflexive edges are allowed

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

NAryTree

public NAryTree()
         throws java.lang.Exception

Constructor.

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.

Specified by:

getGraphHelp in class Graph

initialize

public void initialize()
                throws java.lang.Exception

Calls graph initialize and also set up the nodes Vector if it has not yet been set up

Overrides:

initialize in class Graph

Throws:

java.lang.Exception

randomizeParameters

public void randomizeParameters()

Reset the range of the number of nodes and randomize

Overrides:

randomizeParameters in class ParameterizedObject

checkParameters

protected void checkParameters()
                        throws java.lang.Exception

Makes sure that the parameters are in the proper range

Overrides:

checkParameters in class ALGraph

Throws:

java.lang.Exception - if anything is wrong with the parameter values

hasSymEdges

public boolean hasSymEdges()

It is always the case in N-Ary tree that for every edge a to b there is also an edge b to a.

Specified by:

hasSymEdges in class Graph

reflexEdgesOk

public boolean reflexEdgesOk()

It is never the case in N-ary trees that reflexive edges are allowed

Specified by:

reflexEdgesOk in class Graph

doGenerate

public void doGenerate()

Generates the N-ary tree of the given depth

Specified by:

doGenerate in class ParameterizedObject