utils.list.atoms

Class AtomsArrayList<T extends java.lang.Comparable<T>>

java.lang.Object

utils.list.atoms.AtomsArrayList<T>

Type Parameters:

T -

All Implemented Interfaces:

IAtomsCollection<T>

public class AtomsArrayList<T extends java.lang.Comparable<T>>
extends java.lang.Object
implements IAtomsCollection<T>

Author:

J. Alberdi-Rodriguez

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<T>	atomsArray
private byte	process The "movements" that atom can do.
private double	totalRate

Constructor Summary

Constructors

Constructor and Description
AtomsArrayList(byte process) Array List implementation for atom collection storing.

Method Summary

Modifier and Type	Method and Description
private void	add(T atom)
void	addRate(T atom) Current atom is added.
void	clear() Used to recompute the collection.
double	getTotalRate(byte process)
void	insert(T atom) Current atom is added.
boolean	isEmpty()
java.util.Iterator<T>	iterator()
void	populate() Does nothing.
T	randomElement() Chooses a random atom or island.
void	recomputeTotalRate(byte process)
void	remove(T atom)
void	removeAtomRate(T atom) Removes atom's rate, with its old desorption rate and sets to zero.
void	reset() Used to empty the collection.
T	search(T atom) Return an atom with the same atom Id that was given from the list.
int	size()
void	updateRate(T atom, double diff) Updates total rate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

atomsArray

private final java.util.ArrayList<T extends java.lang.Comparable<T>> atomsArray

totalRate

private double totalRate

process

private final byte process

The "movements" that atom can do. For example: Adsorption, desorption, reaction or diffusion.

Constructor Detail

AtomsArrayList

public AtomsArrayList(byte process)

Array List implementation for atom collection storing.

Parameters:

process - The "movements" that atom can do. For example: Adsorption, desorption, reaction or diffusion.

Method Detail

insert

public void insert(T atom)

Current atom is added. This should only be called in the initialisation. Add atoms only if they have a rate.

Specified by:

insert in interface IAtomsCollection<T extends java.lang.Comparable<T>>

Parameters:

atom -

addRate

public void addRate(T atom)

Current atom is added.

Specified by:

addRate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

Parameters:

atom -

add

private void add(T atom)

remove

public void remove(T atom)

Specified by:

remove in interface IAtomsCollection<T extends java.lang.Comparable<T>>

removeAtomRate

public void removeAtomRate(T atom)

Description copied from interface: IAtomsCollection

Removes atom's rate, with its old desorption rate and sets to zero.

Specified by:

removeAtomRate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

updateRate

public void updateRate(T atom,
                       double diff)

Updates total rate.

Specified by:

updateRate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

Parameters:

atom - Ignored.

diff - Value to be added.

populate

public void populate()

Does nothing.

Specified by:

populate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

recomputeTotalRate

public void recomputeTotalRate(byte process)

Specified by:

recomputeTotalRate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

getTotalRate

public double getTotalRate(byte process)

Specified by:

getTotalRate in interface IAtomsCollection<T extends java.lang.Comparable<T>>

clear

public void clear()

Description copied from interface: IAtomsCollection

Used to recompute the collection.

Specified by:

clear in interface IAtomsCollection<T extends java.lang.Comparable<T>>

reset

public void reset()

Description copied from interface: IAtomsCollection

Used to empty the collection.

Specified by:

reset in interface IAtomsCollection<T extends java.lang.Comparable<T>>

randomElement

public T randomElement()

Description copied from interface: IAtomsCollection

Chooses a random atom or island.

Specified by:

randomElement in interface IAtomsCollection<T extends java.lang.Comparable<T>>

Returns:

atom/island.

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface IAtomsCollection<T extends java.lang.Comparable<T>>

size

public int size()

Specified by:

size in interface IAtomsCollection<T extends java.lang.Comparable<T>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IAtomsCollection<T extends java.lang.Comparable<T>>

search

public T search(T atom)

Return an atom with the same atom Id that was given from the list.

Specified by:

search in interface IAtomsCollection<T extends java.lang.Comparable<T>>

Parameters:

atom - fake atom with correct Id to search for.

Returns:

found atom, null otherwise.