uchicago.src.sim.topology.space
Interface Neighborhood

All Known Implementing Classes:

AbstractNeighborhood, Hex3DNeighborhood, HexNeighborhood, Moore3DNeighborhood, MooreNeighborhood, VonNeumannNeighborhood, VonNeumannNeighborhood

public interface Neighborhood

Author:

Mark Diggory To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Method Summary

java.util.List	emptyLocations(Location location, int extent, boolean includeOrigin)
LocationIterator	emptyLocationsIterator(Location location, int extent, boolean includeOrigin)
java.util.List	findMaximum(Location location, int extent, boolean includeOrigin)
java.util.List	findMinimum(Location location, int extent, boolean includeOrigin)
int	getAgentCount(Location location, int extent, boolean includeOrigin)
int	getNeighborhoodSize(Location location, int extent, boolean includeOrigin)
boolean	isFull(Location location, int extent, boolean includeOrigin)
java.util.List	locations(Location location, int extent, boolean includeOrigin)
LocationIterator	locationsIterator(Location location, int extent, boolean includeOrigin)
NeighborIterator	neighborIterator(Location location, int extent, boolean includeOrigin)
java.util.List	neighbors(Location location, int extent, boolean includeOrigin)
java.util.List	occupiedLocations(Location location, int extent, boolean includeOrigin)
LocationIterator	occupiedLocationsIterator(Location location, int extent, boolean includeOrigin)

Method Detail

isFull

public boolean isFull(Location location,
                      int extent,
                      boolean includeOrigin)

getAgentCount

public int getAgentCount(Location location,
                         int extent,
                         boolean includeOrigin)

getNeighborhoodSize

public int getNeighborhoodSize(Location location,
                               int extent,
                               boolean includeOrigin)

neighbors

public java.util.List neighbors(Location location,
                                int extent,
                                boolean includeOrigin)

neighborIterator

public NeighborIterator neighborIterator(Location location,
                                         int extent,
                                         boolean includeOrigin)

locations

public java.util.List locations(Location location,
                                int extent,
                                boolean includeOrigin)

locationsIterator

public LocationIterator locationsIterator(Location location,
                                          int extent,
                                          boolean includeOrigin)

emptyLocations

public java.util.List emptyLocations(Location location,
                                     int extent,
                                     boolean includeOrigin)

emptyLocationsIterator

public LocationIterator emptyLocationsIterator(Location location,
                                               int extent,
                                               boolean includeOrigin)

occupiedLocations

public java.util.List occupiedLocations(Location location,
                                        int extent,
                                        boolean includeOrigin)

occupiedLocationsIterator

public LocationIterator occupiedLocationsIterator(Location location,
                                                  int extent,
                                                  boolean includeOrigin)

findMinimum

public java.util.List findMinimum(Location location,
                                  int extent,
                                  boolean includeOrigin)

findMaximum

public java.util.List findMaximum(Location location,
                                  int extent,
                                  boolean includeOrigin)