Package com.anylogic.engine
- java.lang.Object
-
- com.anylogic.engine.AgentList<E>
-
- com.anylogic.engine.AgentArrayList<E>
- Type Parameters:
E
- agent type
- All Implemented Interfaces:
com.anylogic.engine.internal.Child
,java.io.Serializable
,java.lang.Iterable<E>
public class AgentArrayList<E extends Agent> extends AgentList<E>
Agent population list based on array implementation
Supports fast element retrieval by its index (the
The add operation runs in amortized constant time, that is, adding n elements requires O(n) time.
Supports fast element retrieval by its index (the
get(int)
operation
runs in constant time).The add operation runs in amortized constant time, that is, adding n elements requires O(n) time.
- Author:
- AnyLogic North America, LLC https://anylogic.com
- See Also:
- Serialized Form
AgentArrayList(Agent owner) |
Constructs an empty list with an initial capacity of ten.
|
Constructor | Description |
---|
void |
_add(E agent) |
This method should not be called by user
Call add_EONAME() method of class containing embedded object
with name EONAME or agent.goToPopulation( population ) |
boolean |
_remove(Agent agent) |
This method should not be called by user
Call remove_EONAME() method of class containing embedded
object with name EONAME or agent.goToPopulation( null ) |
boolean |
contains(java.lang.Object agent) |
Returns
true if this agent population contains the
specified element. |
E |
get(int index) |
Returns the agent element at the specified position in this
agent population.
The position index is the number of list element in the insertion order (i.e. |
boolean |
isEmpty() |
Returns
true if this agent population contains no
elements. |
java.util.Iterator<E> |
iterator() |
Returns an iterator over the agent population.
This iterator guarantees the insertion order of elements (i.e. |
E |
random(java.util.Random r) |
Randomly returns one agent from this population
(ses the specified random number generator to choose the element) This method runs in linear time This method returns null if the population
is empty |
int |
size() |
Returns the number of elements in this agent population.
If this collection contains more than Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE . |
java.util.stream.Stream<E> |
stream() |
Returns a sequential Stream with this agent population as its source.
|
java.lang.String |
toString() |
|
Modifier and Type | Method | Description |
---|
average, average, callCreate, callCreate, callSetupParameters, callSetupParameters, count, fillFromTable, fillFromTable, fillFromTable, findAll, findFirst, getEnvironment, getOwner, getPresentationScaleOnOwnerSpace, getValueFromTable, instantiateAgent, isPresentationEnabled, max, max, min, min, min, onChange, random, randomExcept, randomExcept, restoreOwner, setEnvironment, sum, sum
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public AgentArrayList(Agent owner)
Constructs an empty list with an initial capacity of ten.
@AnyLogicInternalCodegenAPI public void _add(E agent)
Description copied from class:
AgentList
This method should not be called by user
Call
Call
add_EONAME()
method of class containing embedded object
with name EONAME or agent.goToPopulation( population )
@AnyLogicInternalCodegenAPI public boolean _remove(Agent agent)
Description copied from class:
AgentList
This method should not be called by user
Call
Call
remove_EONAME()
method of class containing embedded
object with name EONAME or agent.goToPopulation( null )
public E get(int index)
Description copied from class:
AgentList
Returns the agent element at the specified position in this
agent population.
The position index is the number of list element in the insertion order (i.e. the order in which agent were added to this replicated agent list). Thus, index of an element decreases when preceding elements are removed.
The position index is the number of list element in the insertion order (i.e. the order in which agent were added to this replicated agent list). Thus, index of an element decreases when preceding elements are removed.
- Specified by:
get
in classAgentList<E extends Agent>
- Parameters:
index
- index of the element to return- Returns:
- the element at the specified position in this list
public boolean contains(java.lang.Object agent)
Description copied from class:
AgentList
Returns
true
if this agent population contains the
specified element. More formally, returns true
if and only if
this collection contains at least one element e
such that
(o==null ? e==null : o.equals(e))
.- Specified by:
contains
in classAgentList<E extends Agent>
- Parameters:
agent
- element whose presence in this agent population is to be tested- Returns:
true
if this agent population contains the specified element
public boolean isEmpty()
Description copied from class:
AgentList
Returns
true
if this agent population contains no
elements.- Specified by:
isEmpty
in classAgentList<E extends Agent>
- Returns:
true
if this agent population contains no elements
public java.util.Iterator<E> iterator()
Description copied from class:
AgentList
Returns an iterator over the agent population.
This iterator guarantees the insertion order of elements (i.e. the order in which agent were added to this agent population list).
Note, that returned iterator doesn't support remove operation
This iterator guarantees the insertion order of elements (i.e. the order in which agent were added to this agent population list).
Note, that returned iterator doesn't support remove operation
- Specified by:
iterator
in interfacejava.lang.Iterable<E extends Agent>
- Specified by:
iterator
in classAgentList<E extends Agent>
- Returns:
- an
Iterator
over the elements in this replicated agent
public java.util.stream.Stream<E> stream()
Description copied from class:
AgentList
Returns a sequential Stream with this agent population as its source.
public int size()
Description copied from class:
AgentList
Returns the number of elements in this agent population.
If this collection contains more than
If this collection contains more than
Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE
.- Specified by:
size
in classAgentList<E extends Agent>
- Returns:
- the number of elements in this agent population
public E random(java.util.Random r)
Description copied from class:
AgentList
Randomly returns one agent from this population
(ses the specified random number generator to choose the element)
This method runs in linear time
This method returns
(ses the specified random number generator to choose the element)
This method runs in linear time
This method returns
null
if the population
is empty- Overrides:
random
in classAgentList<E extends Agent>
- Parameters:
r
- the random number generator.- Returns:
- the agent randomly chosen from this population
(uses uniform distribution from the Engine)
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
How can we improve this article?
-