Package com.bayesserver

Class StateCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<State>

com.bayesserver.StateCollection

All Implemented Interfaces:

Iterable<State>, Collection<State>, List<State>

public final class StateCollection
extends AbstractList<State>

Represents a collection of states belonging to a Variable. Note that a continuous variable always has a single state.

See Also:

State

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
void	add(int index, State item)	Inserts an element into the collection at the specified index.
void	clear()
boolean	contains(Object o)	Determines whether a State is in the collection.
State	findByValue(Object value)	Finds the state whose value/> matches the given [value], or null if a match is not found.
State	get(int index)	Gets the State at the specified index.
State	get(String name)	Performs a case sensitive lookup.
State	get(String name, boolean throwIfNotFound)	Performs a case sensitive lookup.
boolean	getIsReadOnly()	Gets a value indicating whether or not the collection is read-only.
Variable	getVariable()	Gets the Variable this collection belongs to.
int	indexOf(Object o)	Determines the index of a specific State in the collection.
State	remove(int index)	Removes an element from the collection at the specified index.
State	set(int index, State value)	Sets the State at the specified index.
int	size()

Methods inherited from class java.util.AbstractList

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

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Method Detail

size

public int size()

Specified by:

size in interface Collection<State>

Specified by:

size in interface List<State>

Specified by:

size in class AbstractCollection<State>

getIsReadOnly

public boolean getIsReadOnly()

Gets a value indicating whether or not the collection is read-only. This will be true for continuous variables.

getVariable

public Variable getVariable()

Gets the Variable this collection belongs to. This is null if this is a child state collection.

Returns:

The variable that owns this collection.

get

public State get(String name)

Performs a case sensitive lookup.

Parameters:

name - The name of the State to find.

Returns:

A State with the specified name if found; otherwise null.

get

public State get(String name,
                 boolean throwIfNotFound)

Performs a case sensitive lookup.

Parameters:

name - The name of the State to find.

throwIfNotFound - When true throws an exception if the name is not found.

Returns:

The State with the specified name; otherwise null.

findByValue

public State findByValue(Object value)

Finds the state whose value/> matches the given [value], or null if a match is not found. For discretized variables, each State.getValue() is an Interval, and this method returns the state whose interval contains the given [value].

Parameters:

value - The value to match to a State.getValue().

Returns:

The matching State or null if a match is not found.

get

public State get(int index)

Gets the State at the specified index.

Specified by:

get in interface List<State>

Specified by:

get in class AbstractList<State>

Returns:

The state.

set

public State set(int index,
                 State value)

Sets the State at the specified index.

Specified by:

set in interface List<State>

Overrides:

set in class AbstractList<State>

Parameters:

value - The state.

clear

public void clear()

Specified by:

clear in interface Collection<State>

Specified by:

clear in interface List<State>

Overrides:

clear in class AbstractList<State>

contains

public boolean contains(Object o)

Determines whether a State is in the collection. The operation is O(1).

Specified by:

contains in interface Collection<State>

Specified by:

contains in interface List<State>

Overrides:

contains in class AbstractCollection<State>

Parameters:

o - The State to locate in the collection. The value can be null.

Returns:

true if [o] is found in the collection; otherwise, false.

indexOf

public int indexOf(Object o)

Determines the index of a specific State in the collection. This operation is O(1).

Specified by:

indexOf in interface List<State>

Overrides:

indexOf in class AbstractList<State>

Parameters:

o - The state to find. The value can be null.

Returns:

The index of the state in the collection, or -1 if not found.

add

public void add(int index,
                State item)

Inserts an element into the collection at the specified index.

Specified by:

add in interface List<State>

Overrides:

add in class AbstractList<State>

Parameters:

index - The zero based index at which to add the element.

item - The item to insert. Cannot be null.

Throws:

NullPointerException - Raised when [item] is null.

IllegalStateException - Raised if the state already belongs to a network.

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.

remove

public State remove(int index)

Removes an element from the collection at the specified index.

Specified by:

remove in interface List<State>

Overrides:

remove in class AbstractList<State>

Parameters:

index - The zero based index at which to remove the element.

Throws:

IllegalArgumentException - index is less than 0.-or-index is equal to or greater than the collection count.