localsolver

Class LSInterval

java.lang.Object

localsolver.LSInterval

public class LSInterval
extends java.lang.Object

Value type for interval expressions. Such value is obtained with LSExpression.getIntervalValue() or LSSolution.getIntervalValue(localsolver.LSExpression).

Since:

12.0

See Also:

LSSolution, LSExpression

Constructor Summary

Constructors

Constructor and Description
LSInterval()
LSInterval(long start, long end)

Method Summary

Modifier and Type	Method and Description
boolean	contains(long value) Returns true if the interval contains the given value, false otherwise.
long	count() Returns the number of elements in the interval.
boolean	equals(java.lang.Object obj)
long	getEnd() Returns the end of the interval.
long	getStart() Returns the start of the interval.
int	hashCode()
boolean	isDegenerate() Returns true if the interval is degenerate.
boolean	isVoid() Returns true if the interval is void.
java.util.Iterator<java.lang.Long>	iterator() Returns an iterator for the content of this interval.
java.lang.String	toString() Returns a string representation of the interval.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LSInterval

public LSInterval()

LSInterval

public LSInterval(long start,
                  long end)

Method Detail

isVoid

public boolean isVoid()

Returns true if the interval is void. A void interval is an empty interval with no valid start or end bounds.

Returns:

True if the interval is void.

isDegenerate

public boolean isDegenerate()

Returns true if the interval is degenerate. A degenerate interval is an interval with equal start and end bounds. It does not contain any element however.

Returns:

True if the interval is degenerate.

getStart

public long getStart()

Returns the start of the interval. Cannot be called on a void interval as it does not have a valid start.

Returns:

Start of the interval.

getEnd

public long getEnd()

Returns the end of the interval. Cannot be called on a void interval as it does not have a valid end.

Returns:

End of the interval.

count

public long count()

Returns the number of elements in the interval. A void or degenerate interval does not contain any element.

Returns:

Number of elements in the interval.

contains

public boolean contains(long value)

Returns true if the interval contains the given value, false otherwise.

Parameters:

value - Element whose presence in this interval is to be tested.

Returns:

True if the interval contains the value

toString

public java.lang.String toString()

Returns a string representation of the interval.

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

iterator

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

Returns an iterator for the content of this interval.

Returns:

Read-only iterator for the content of this interval.