localsolver

Class LSCollection

java.lang.Object

localsolver.LSCollection

All Implemented Interfaces:

java.lang.Iterable<java.lang.Long>

public class LSCollection
extends java.lang.Object
implements java.lang.Iterable<java.lang.Long>

Value type for collection expressions (lists). Such a value is obtained with LSExpression::getCollectionValue(). It represents a reference to the value of a variable and the value of this variable is modified when the LSCollection object if modified.

Since:

5.5

See Also:

LSModel, LSExpression

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long val) Adds the given value to this collection.
void	clear() Remove all values of this collection.
long	count() Gets the number of values in the collection.
boolean	equals(java.lang.Object obj)
long	get(int position) Gets the value at the given position.
int	getIndex() Gets the index of the corresponding expression in the model.
int	hashCode()
java.util.Iterator<java.lang.Long>	iterator() Returns an iterator for the content of this collection.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getIndex

public int getIndex()

Gets the index of the corresponding expression in the model.

Returns:

Index in the model.

add

public void add(long val)

Adds the given value to this collection. Only allowed in state LSState.Modeling. This function will fail if the given value is outside of the range of the list or if this value is already included in this list (remind that a list cannot contain twice the same value.

Parameters:

val - The value to be added.

clear

public void clear()

Remove all values of this collection. Only allowed in state LSState.Modeling.

count

public long count()

Gets the number of values in the collection.

get

public long get(int position)

Gets the value at the given position.

Parameters:

position - The considered position (must be non negative and striclty smaller than the number of values in the collection).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

iterator

public java.util.Iterator<java.lang.Long> iterator()

Returns an iterator for the content of this collection.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Long>