Package etomica.atom

Class AtomArrayList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<IAtom>

etomica.atom.AtomArrayList

All Implemented Interfaces:

IAtomList, java.lang.Iterable<IAtom>, java.util.Collection<IAtom>, java.util.List<IAtom>, java.util.RandomAccess

public final class AtomArrayList
extends java.util.AbstractList<IAtom>
implements IAtomList, java.util.RandomAccess

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AtomArrayList()
AtomArrayList(int initialSize)
AtomArrayList(IAtomList list)

Method Summary

Modifier and Type	Method	Description
boolean	add(IAtom atom)
void	addAll(IAtomList atoms)
void	clear()
boolean	contains(IAtom elem)	Returns true if the given atom is in the list, false otherwise
void	ensureCapacity(int minCapacity)
IAtom	get(int index)	Returns the i-th atom, with numbering beginning from 0.
static float	getSizeIncreaseRatio()
float	getTrimThreshold()
int	indexOf(IAtom elem)
boolean	isEmpty()
void	maybeTrimToSize()
IAtom	remove(int index)	This removes the atom at the given index and shifts the remaining atoms back (maintaining the order).
IAtom	removeAndReplace(int index)	This removes the atom at the given index and replaces the hole with the last atom.
IAtom	set(int index, IAtom element)
void	setTrimThreshold(float newTrimThreshold)
int	size()
int	sizeOfArray()
IAtom[]	toArray()
IAtom[]	toAtomLeafArray()
java.lang.String	toString()
void	trimToSize()

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, remove, removeAll, retainAll, toArray

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface etomica.atom.IAtomList

getAtoms

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, addAll, addAll, contains, containsAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, removeAll, replaceAll, retainAll, sort, spliterator, subList, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AtomArrayList

public AtomArrayList()

AtomArrayList

public AtomArrayList(int initialSize)

AtomArrayList

public AtomArrayList(IAtomList list)

Method Detail

getSizeIncreaseRatio

public static float getSizeIncreaseRatio()

trimToSize

public void trimToSize()

maybeTrimToSize

public void maybeTrimToSize()

getTrimThreshold

public float getTrimThreshold()

setTrimThreshold

public void setTrimThreshold(float newTrimThreshold)

ensureCapacity

public void ensureCapacity(int minCapacity)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<IAtom>

Specified by:

isEmpty in interface java.util.List<IAtom>

Overrides:

isEmpty in class java.util.AbstractCollection<IAtom>

toArray

public IAtom[] toArray()

Specified by:

toArray in interface java.util.Collection<IAtom>

Specified by:

toArray in interface java.util.List<IAtom>

Overrides:

toArray in class java.util.AbstractCollection<IAtom>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<IAtom>

Specified by:

clear in interface java.util.List<IAtom>

Overrides:

clear in class java.util.AbstractList<IAtom>

sizeOfArray

public int sizeOfArray()

indexOf

public int indexOf(IAtom elem)

contains

public boolean contains(IAtom elem)

Returns true if the given atom is in the list, false otherwise

toAtomLeafArray

public IAtom[] toAtomLeafArray()

set

public IAtom set(int index,
                 IAtom element)

Specified by:

set in interface java.util.List<IAtom>

Overrides:

set in class java.util.AbstractList<IAtom>

add

public boolean add(IAtom atom)

Specified by:

add in interface java.util.Collection<IAtom>

Specified by:

add in interface java.util.List<IAtom>

Overrides:

add in class java.util.AbstractList<IAtom>

addAll

public void addAll(IAtomList atoms)

remove

public IAtom remove(int index)

This removes the atom at the given index and shifts the remaining atoms back (maintaining the order).

Specified by:

remove in interface java.util.List<IAtom>

Overrides:

remove in class java.util.AbstractList<IAtom>

removeAndReplace

public IAtom removeAndReplace(int index)

This removes the atom at the given index and replaces the hole with the last atom. This is faster than the remove() method.

size

public int size()

Specified by:

size in interface java.util.Collection<IAtom>

Specified by:

size in interface IAtomList

Specified by:

size in interface java.util.List<IAtom>

Specified by:

size in class java.util.AbstractCollection<IAtom>

Returns:

the number of atoms in the list

get

public IAtom get(int index)

Description copied from interface: IAtomList

Returns the i-th atom, with numbering beginning from 0.

Specified by:

get in interface IAtomList

Specified by:

get in interface java.util.List<IAtom>

Specified by:

get in class java.util.AbstractList<IAtom>

Parameters:

index - the index of the desired atom in the list if i is greater than count-1, throws an IllegalArgumentException.

Returns:

the requested atom

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<IAtom>