localsolver

Class LSArray

java.lang.Object

localsolver.LSArray

public class LSArray
extends java.lang.Object

Value type for array expressions. Such value is obtained with LSExpression.getArrayValue() or LSSolution.getArrayValue(localsolver.LSExpression). An array contains values of type lsint, lsdouble or LSArray (for multi-dimensional arrays). Note that it's possible to mix integers or doubles in the same array. Arrays are not decisions and cannot be modified.

Since:

7.5

See Also:

LSSolution, LSExpression

Method Summary

Modifier and Type	Method and Description
int	count() Returns the number of elements in the array.
boolean	equals(java.lang.Object obj)
LSArray	getArrayValue(int pos) Returns the array value at the given position.
double	getDoubleValue(int pos) Returns the double value at the given position.
long	getIntValue(int pos) Returns the integer value at the given position.
int	hashCode()
boolean	isArray(int pos) Returns true if the value at the given position is an array.
boolean	isBool(int pos) Returns true if the value at the given position is a boolean.
boolean	isDouble(int pos) Returns true if the value at the given position is a double.
boolean	isInt(int pos) Returns true if the value at the given position is an integer.
java.lang.String	toString() Returns a string representation of the values in the array in the format "{ val0, val1, ..., valN }"

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

count

public int count()

Returns the number of elements in the array. Elements in arrays are indexed from 0 to count()-1

isBool

public boolean isBool(int pos)

Returns true if the value at the given position is a boolean. You can retrieve the value with getIntValue(int).

Parameters:

pos - Position of the value to query.

Returns:

True if the value at the given position is a boolean.

isInt

public boolean isInt(int pos)

Returns true if the value at the given position is an integer. You can retrieve the value with getIntValue(int).

Parameters:

pos - Position of the value to query.

Returns:

True if the value at the given position is an integer.

isDouble

public boolean isDouble(int pos)

Returns true if the value at the given position is a double. You can retrieve the value with getDoubleValue(int).

Parameters:

pos - Position of the value to query.

Returns:

True if the value at the given position is a double.

isArray

public boolean isArray(int pos)

Returns true if the value at the given position is an array. You can retrieve the value with getArrayValue(int).

Parameters:

pos - Position of the value to query.

Returns:

True if the value at the given position is an array.

getIntValue

public long getIntValue(int pos)

Returns the integer value at the given position. If the value is neither an integer nor a boolean, an exception is thrown.

Parameters:

pos - Position of the value to query.

Returns:

Integer value.

getDoubleValue

public double getDoubleValue(int pos)

Returns the double value at the given position. If the value is not a double, an exception is thrown.

Parameters:

pos - Position of the value to query.

Returns:

Double value.

getArrayValue

public LSArray getArrayValue(int pos)

Returns the array value at the given position. If the value is not an array, an exception is thrown.

Parameters:

pos - Position of the value to query.

Returns:

Array value.

toString

public java.lang.String toString()

Returns a string representation of the values in the array in the format "{ val0, val1, ..., valN }"

Overrides:

toString in class java.lang.Object

Returns:

String representation.

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