Package HAL.GridsAndAgents
Class AgentGrid1D<T extends AgentBaseSpatial>
- java.lang.Object
-
- HAL.GridsAndAgents.AgentGrid1D<T>
-
- Type Parameters:
T- the type of agent that the AgentGrid1D will hold
- All Implemented Interfaces:
Grid1D,java.io.Serializable,java.lang.Iterable<T>
public class AgentGrid1D<T extends AgentBaseSpatial> extends java.lang.Object implements Grid1D, java.lang.Iterable<T>, java.io.Serializable
AgentGrid1Ds can hold any type of 1D agent- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AgentGrid1D(int x, java.lang.Class<T> agentClass)pass to the constructor the dimensions of the grid and the agent class type, written T.type where T is the name of the occupying agent class.AgentGrid1D(int x, java.lang.Class<T> agentClass, boolean wrapX)pass to the constructor the dimensions of the grid and the agent class type, written T.type where T is the name of the occupying agent class.
-
Method Summary
Modifier and Type Method Description void_PassAgentConstructor(java.lang.Class<T> agentClass)meant to be used specifically in conjunction with the LoadState Utils function.java.util.List<T>AllAgents()returns the list of all agents as an unmodifiable listjava.util.List<T>AllDeads()returns the list of all dead agents as an unmodifiable listintApplyAgentsRad(double rad, double x, AgentRadDispToAction1D<T> action)applies AgentRadDispToAction2D function to all agents within radiusvoidCleanAgents()cleans the list of agents, removing dead ones, may improve the efficiency of the agent iteration if many agents have died do not call this while in the middle of iterationvoidCleanShuffle(Rand rn)calls CleanAgents, then ShuffleAgentsTGetAgent(int x)Gets a single agent at the specified grid square, beware using this function with stackable agents, as it will only return one of the stack of agents.voidGetAgents(java.util.ArrayList<T> putHere, int x)appends to the provided arraylist all agents on the square at the specified coordinatesvoidGetAgents(java.util.ArrayList<T> putHere, int x, AgentToBool<T> EvalAgent)appends to the provided arraylist all agents on the square at the specified coordinates, will subset only agents for which EvalAgent returns trueTGetAgentSafe(int x)Same as GetAgent above, but if x or y are outside the domain, it will apply wrap around if wrapping is enabled, or return null.voidGetAgentsHood(java.util.ArrayList<T> retAgentList, int[] hood, int centerX)gets all agents within the given neighborhood and adds them to the ArrayList argumentvoidGetAgentsHood(java.util.ArrayList<T> retAgentList, int[] hood, int centerX, AgentToBool<T> EvalAgent)gets all agents within the given neighborhood forwhich EvalAgent returns true and adds them to the ArrayList argumentvoidGetAgentsHoodMapped(java.util.ArrayList<T> retAgentList, int[] hood, int hoodLen)gets all agents in the provided neighborhood, assumes that the neighborhood has already been mapped to a locationvoidGetAgentsHoodMapped(java.util.ArrayList<T> retAgentList, int[] hood, int hoodLen, AgentToBool<T> EvalAgent)gets all agents in the provided neighborhood forwhich EvalAgent returns true, assumes that the neighborhood has already been mapped to a locationvoidGetAgentsRad(java.util.ArrayList<T> retAgentList, double x, double rad)gets all agents that are within rad, and adds them to the ArrayListvoidGetAgentsRad(java.util.ArrayList<T> retAgentList, double x, double rad, AgentToBool<T> EvalAgent)gets all agents that are within rad forwhich EvalAgent returns true, and adds them to the ArrayListvoidGetAgentsRad(java.util.ArrayList<T> retAgentList, java.util.ArrayList<double[]> displacementInfo, double x, double rad)gets all agents that are within rad, and adds them to the ArrayListvoidGetAgentsRad(java.util.ArrayList<T> retAgentList, java.util.ArrayList<double[]> displacementInfo, double x, double rad, AgentToBool<T> EvalAgent)gets all agents that are within rad forwhich EvalAgent returns true, and adds them to the ArrayListvoidGetAgentsRadApprox(java.util.ArrayList<T> retAgentList, double x, double rad)quickly gets all agents that are within rad, but also includes some that are further away than rad, an additional distance check should be used to properly subset this groupvoidGetAgentsRadApprox(java.util.ArrayList<T> retAgentList, double x, double rad, AgentToBool<T> EvalAgent)quickly gets all agents that are within rad, but also includes some that are further away than rad, an additional distance check should be used to properly subset this group.voidGetAgentsRect(java.util.ArrayList<T> retAgentList, int x, int width)gets all agents within the rectangle argument defined by the bottom corner and the dimension argumentsvoidGetAgentsRect(java.util.ArrayList<T> retAgentList, int x, int width, AgentToBool<T> EvalAgent)gets all agents forwhich evalAgent returns true within the rectangle argument defined by the bottom corner and the dimension argumentsvoidGetAgentsSafe(java.util.ArrayList<T> putHere, int x)appends to the provided arraylist all agents on the square at the specified coordinates, will apply wraparound if the coordinates are outside the domainvoidGetAgentsSafe(java.util.ArrayList<T> putHere, int x, AgentToBool<T> EvalAgent)appends to the provided arraylist all agents on the square at the specified coordinates, will apply wraparound if the coordinates are outside the domain, will subset only agents for which EvalAgent returns trueintGetTick()gets the current grid timestep.voidIncTick()increments the internal grid tick counter by 1, used with the Age() and BirthTick() functions to get age information about the agents on an AgentGrid.booleanIsWrapX()java.lang.Iterable<T>IterAgents(int x)iterates over all agents at positionjava.lang.Iterable<T>IterAgentsHood(int[] hood, int centerX)iterates over all agents found in a neighborhood after mappingjava.lang.Iterable<T>IterAgentsHoodMapped(int[] hood, int hoodLen)iterates over all agents found in an already mapped neighborhoodjava.lang.Iterable<T>IterAgentsRad(double x, double rad)iterates over all agents within radiusjava.lang.Iterable<T>IterAgentsRadApprox(double x, double rad)iterates over all agents within radius, will include some over rad as well, use a second distance check to filter thesejava.lang.Iterable<T>IterAgentsRect(int x, int width)iterates over all agents in the rectangle defined by (x,y) as the lower left corner, and (x+width,y+height) as the top right corner.java.lang.Iterable<T>IterAgentsSafe(int x)Same as IterAgents above, but will apply wraparound if x,y fall outside the grid dimensions.java.util.Iterator<T>iterator()intLength()intMapEmptyHood(int[] hood, int centerX)similar to the MapHood function, but will only include indices of locations that are emptyintMapOccupiedHood(int[] hood, int centerX)similar to the MapHood function, but will only include indices of locations that are occupiedTNewAgentPT(double x)returns an uninitialized agent at the specified coordinatesTNewAgentPTSafe(double newX)returns an uninitialized agent at the specified coordinates, will apply wraparound if the coordinates are outside the domainTNewAgentPTSafe(double newX, double fallbackX)returns an uninitialized agent at the specified coordinates, will apply wraparound or use the fallback if the coordinates are outside the domainTNewAgentSQ(int x)returns an uninitialized agent at the specified coordinatesintPop()returns the number of agents that are alive in the gridintPopAt(int x)gets the population at a specific locationintPopAt(int x, AgentToBool EvalAgent)gets the population at a specific location, subsetting to only those for which EvalAgent returns trueTRandomAgent(int x, Rand rn)returns a single random agent from the provided coordinatesTRandomAgent(int x, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent from the provided coordinates forwhich EvalAgent returns trueTRandomAgent(Rand rn)gets a random agent from the grid, be careful not to use this during iteration over the gridTRandomAgentHood(int[] hood, int x, Rand rn)returns a single random agent from the set of all agents within the specified neighborhoodTRandomAgentHood(int[] hood, int x, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent from the set of all agents within the specified neighborhood forwhich EvalAgent returns trueTRandomAgentHoodMapped(int[] hood, int hoodLen, Rand rn)returns a single random agent from the set of all agents within the specified neighborhood, assumes the neighborhood has already been mappedTRandomAgentHoodMapped(int[] hood, int hoodLen, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent from the set of all agents within the specified neighborhood forwhich EvalAgent returns true, assumes the neighborhood has already been mappedTRandomAgentRad(double x, double rad, Rand rn)returns a single random agent from the set of all agents within the specified radiusTRandomAgentRad(double x, double rad, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent from the set of all agents within the specified radius forwhich EvalAgent returns trueTRandomAgentRect(int x, int width, Rand rn)returns a single random agent from the set of all agents within the specified rectangleTRandomAgentRect(int x, int width, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent from the set of all agents within the specified rectangle forwhich EvalAgent returns trueTRandomAgentSafe(int x, Rand rn)returns a single random agent, will apply wraparound if the coordiantes are outside of the gridTRandomAgentSafe(int x, Rand rn, AgentToBool<T> EvalAgent)returns a single random agent that satisfies EvalAgent, will apply wraparound if the coordiantes are outside of the gridvoidReset()calls dispose on all agents, resets the tick timer to 0.voidResetHard()calls dispose on all agents and completely resets the internal agentlist, also resets the tick timer to 0.voidResetTick()sets the tick to 0.voidShuffleAgents(Rand rn)shuffles the agent list to randomize iteration.intXdim()-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface HAL.Interfaces.Grid1D
ApplyHood, ApplyHoodMapped, ApplyRectangle, ContainsValidI, DispX, Dist, DistSquared, GetHoodI, In, In, InWrap, InWrap, MapHood, MapHood, MapXpt, MapXsq, RandomHoodI, WrapI
-
-
-
-
Constructor Detail
-
AgentGrid1D
public AgentGrid1D(int x, java.lang.Class<T> agentClass, boolean wrapX)pass to the constructor the dimensions of the grid and the agent class type, written T.type where T is the name of the occupying agent class. the wrap booleans specify whether to domain should use wraparound or stop at the boundary
-
AgentGrid1D
public AgentGrid1D(int x, java.lang.Class<T> agentClass)pass to the constructor the dimensions of the grid and the agent class type, written T.type where T is the name of the occupying agent class.
-
-
Method Detail
-
_PassAgentConstructor
public void _PassAgentConstructor(java.lang.Class<T> agentClass)
meant to be used specifically in conjunction with the LoadState Utils function. LoadState won't by default setup the grid constructor, so this function must be called as well for the loaded grid to be able to create more agents. pass in the same class argument as is normally used by the grid constructor
-
GetAgent
public T GetAgent(int x)
Gets a single agent at the specified grid square, beware using this function with stackable agents, as it will only return one of the stack of agents. This function is recommended for the Unstackable Agents, as it tends to perform better than the other methods for single agent accesses.
-
GetAgentSafe
public T GetAgentSafe(int x)
Same as GetAgent above, but if x or y are outside the domain, it will apply wrap around if wrapping is enabled, or return null.
-
NewAgentSQ
public T NewAgentSQ(int x)
returns an uninitialized agent at the specified coordinates
-
NewAgentPT
public T NewAgentPT(double x)
returns an uninitialized agent at the specified coordinates
-
NewAgentPTSafe
public T NewAgentPTSafe(double newX)
returns an uninitialized agent at the specified coordinates, will apply wraparound if the coordinates are outside the domain
-
NewAgentPTSafe
public T NewAgentPTSafe(double newX, double fallbackX)
returns an uninitialized agent at the specified coordinates, will apply wraparound or use the fallback if the coordinates are outside the domain
-
CleanShuffle
public void CleanShuffle(Rand rn)
calls CleanAgents, then ShuffleAgents
-
ShuffleAgents
public void ShuffleAgents(Rand rn)
shuffles the agent list to randomize iteration. do not call this while in the middle of iteration
-
CleanAgents
public void CleanAgents()
cleans the list of agents, removing dead ones, may improve the efficiency of the agent iteration if many agents have died do not call this while in the middle of iteration
-
AllAgents
public java.util.List<T> AllAgents()
returns the list of all agents as an unmodifiable list
-
AllDeads
public java.util.List<T> AllDeads()
returns the list of all dead agents as an unmodifiable list
-
GetAgents
public void GetAgents(java.util.ArrayList<T> putHere, int x)
appends to the provided arraylist all agents on the square at the specified coordinates
-
GetAgents
public void GetAgents(java.util.ArrayList<T> putHere, int x, AgentToBool<T> EvalAgent)
appends to the provided arraylist all agents on the square at the specified coordinates, will subset only agents for which EvalAgent returns true
-
GetAgentsSafe
public void GetAgentsSafe(java.util.ArrayList<T> putHere, int x)
appends to the provided arraylist all agents on the square at the specified coordinates, will apply wraparound if the coordinates are outside the domain
-
GetAgentsSafe
public void GetAgentsSafe(java.util.ArrayList<T> putHere, int x, AgentToBool<T> EvalAgent)
appends to the provided arraylist all agents on the square at the specified coordinates, will apply wraparound if the coordinates are outside the domain, will subset only agents for which EvalAgent returns true
-
GetAgentsRadApprox
public void GetAgentsRadApprox(java.util.ArrayList<T> retAgentList, double x, double rad)
quickly gets all agents that are within rad, but also includes some that are further away than rad, an additional distance check should be used to properly subset this group
-
GetAgentsRadApprox
public void GetAgentsRadApprox(java.util.ArrayList<T> retAgentList, double x, double rad, AgentToBool<T> EvalAgent)
quickly gets all agents that are within rad, but also includes some that are further away than rad, an additional distance check should be used to properly subset this group. only agents forwhich EvalAgent returns true will be added
-
GetAgentsRad
public void GetAgentsRad(java.util.ArrayList<T> retAgentList, java.util.ArrayList<double[]> displacementInfo, double x, double rad)
gets all agents that are within rad, and adds them to the ArrayList
-
GetAgentsRad
public void GetAgentsRad(java.util.ArrayList<T> retAgentList, java.util.ArrayList<double[]> displacementInfo, double x, double rad, AgentToBool<T> EvalAgent)
gets all agents that are within rad forwhich EvalAgent returns true, and adds them to the ArrayList
-
GetAgentsRad
public void GetAgentsRad(java.util.ArrayList<T> retAgentList, double x, double rad)
gets all agents that are within rad, and adds them to the ArrayList
-
GetAgentsRad
public void GetAgentsRad(java.util.ArrayList<T> retAgentList, double x, double rad, AgentToBool<T> EvalAgent)
gets all agents that are within rad forwhich EvalAgent returns true, and adds them to the ArrayList
-
GetAgentsRect
public void GetAgentsRect(java.util.ArrayList<T> retAgentList, int x, int width)
gets all agents within the rectangle argument defined by the bottom corner and the dimension arguments
-
GetAgentsRect
public void GetAgentsRect(java.util.ArrayList<T> retAgentList, int x, int width, AgentToBool<T> EvalAgent)
gets all agents forwhich evalAgent returns true within the rectangle argument defined by the bottom corner and the dimension arguments
-
GetAgentsHood
public void GetAgentsHood(java.util.ArrayList<T> retAgentList, int[] hood, int centerX)
gets all agents within the given neighborhood and adds them to the ArrayList argument
-
GetAgentsHood
public void GetAgentsHood(java.util.ArrayList<T> retAgentList, int[] hood, int centerX, AgentToBool<T> EvalAgent)
gets all agents within the given neighborhood forwhich EvalAgent returns true and adds them to the ArrayList argument
-
GetAgentsHoodMapped
public void GetAgentsHoodMapped(java.util.ArrayList<T> retAgentList, int[] hood, int hoodLen)
gets all agents in the provided neighborhood, assumes that the neighborhood has already been mapped to a location
-
GetAgentsHoodMapped
public void GetAgentsHoodMapped(java.util.ArrayList<T> retAgentList, int[] hood, int hoodLen, AgentToBool<T> EvalAgent)
gets all agents in the provided neighborhood forwhich EvalAgent returns true, assumes that the neighborhood has already been mapped to a location
-
Reset
public void Reset()
calls dispose on all agents, resets the tick timer to 0.
-
ResetHard
public void ResetHard()
calls dispose on all agents and completely resets the internal agentlist, also resets the tick timer to 0.
-
PopAt
public int PopAt(int x)
gets the population at a specific location
-
PopAt
public int PopAt(int x, AgentToBool EvalAgent)gets the population at a specific location, subsetting to only those for which EvalAgent returns true
-
RandomAgent
public T RandomAgent(Rand rn)
gets a random agent from the grid, be careful not to use this during iteration over the grid
-
ApplyAgentsRad
public int ApplyAgentsRad(double rad, double x, AgentRadDispToAction1D<T> action)applies AgentRadDispToAction2D function to all agents within radius
-
Pop
public int Pop()
returns the number of agents that are alive in the grid
-
MapEmptyHood
public int MapEmptyHood(int[] hood, int centerX)similar to the MapHood function, but will only include indices of locations that are empty
-
MapOccupiedHood
public int MapOccupiedHood(int[] hood, int centerX)similar to the MapHood function, but will only include indices of locations that are occupied
-
IterAgentsSafe
public java.lang.Iterable<T> IterAgentsSafe(int x)
Same as IterAgents above, but will apply wraparound if x,y fall outside the grid dimensions.
-
IterAgents
public java.lang.Iterable<T> IterAgents(int x)
iterates over all agents at position
-
IterAgentsRadApprox
public java.lang.Iterable<T> IterAgentsRadApprox(double x, double rad)
iterates over all agents within radius, will include some over rad as well, use a second distance check to filter these
-
IterAgentsRad
public java.lang.Iterable<T> IterAgentsRad(double x, double rad)
iterates over all agents within radius
-
IterAgentsRect
public java.lang.Iterable<T> IterAgentsRect(int x, int width)
iterates over all agents in the rectangle defined by (x,y) as the lower left corner, and (x+width,y+height) as the top right corner.
-
IterAgentsHood
public java.lang.Iterable<T> IterAgentsHood(int[] hood, int centerX)
iterates over all agents found in a neighborhood after mapping
-
IterAgentsHoodMapped
public java.lang.Iterable<T> IterAgentsHoodMapped(int[] hood, int hoodLen)
iterates over all agents found in an already mapped neighborhood
-
RandomAgentSafe
public T RandomAgentSafe(int x, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent that satisfies EvalAgent, will apply wraparound if the coordiantes are outside of the grid
-
RandomAgentSafe
public T RandomAgentSafe(int x, Rand rn)
returns a single random agent, will apply wraparound if the coordiantes are outside of the grid
-
RandomAgent
public T RandomAgent(int x, Rand rn)
returns a single random agent from the provided coordinates
-
RandomAgent
public T RandomAgent(int x, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent from the provided coordinates forwhich EvalAgent returns true
-
RandomAgentRad
public T RandomAgentRad(double x, double rad, Rand rn)
returns a single random agent from the set of all agents within the specified radius
-
RandomAgentRad
public T RandomAgentRad(double x, double rad, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent from the set of all agents within the specified radius forwhich EvalAgent returns true
-
RandomAgentRect
public T RandomAgentRect(int x, int width, Rand rn)
returns a single random agent from the set of all agents within the specified rectangle
-
RandomAgentRect
public T RandomAgentRect(int x, int width, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent from the set of all agents within the specified rectangle forwhich EvalAgent returns true
-
RandomAgentHood
public T RandomAgentHood(int[] hood, int x, Rand rn)
returns a single random agent from the set of all agents within the specified neighborhood
-
RandomAgentHood
public T RandomAgentHood(int[] hood, int x, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent from the set of all agents within the specified neighborhood forwhich EvalAgent returns true
-
RandomAgentHoodMapped
public T RandomAgentHoodMapped(int[] hood, int hoodLen, Rand rn)
returns a single random agent from the set of all agents within the specified neighborhood, assumes the neighborhood has already been mapped
-
RandomAgentHoodMapped
public T RandomAgentHoodMapped(int[] hood, int hoodLen, Rand rn, AgentToBool<T> EvalAgent)
returns a single random agent from the set of all agents within the specified neighborhood forwhich EvalAgent returns true, assumes the neighborhood has already been mapped
-
iterator
public java.util.Iterator<T> iterator()
- Specified by:
iteratorin interfacejava.lang.Iterable<T extends AgentBaseSpatial>
-
IncTick
public void IncTick()
increments the internal grid tick counter by 1, used with the Age() and BirthTick() functions to get age information about the agents on an AgentGrid. can otherwise be used as a counter with the other grid types.
-
GetTick
public int GetTick()
gets the current grid timestep.
-
ResetTick
public void ResetTick()
sets the tick to 0.
-
-