This page is for an old version of Hexaly Optimizer. We recommend that you update your version and read the documentation for the latest stable release.

LSInterval Class

class localsolver.LSInterval

Value type for interval expressions. Such value is obtained with LSExpression::value when the expression is an interval.

Summary

Methods

is_void

Returns true if the interval is void.

is_degenerate

Returns true if the interval is degenerate.

start

Returns the start of the interval.

end

Returns the end of the interval.

count

Returns the number of elements in the interval.

contains

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

Special methods

__str__

Returns a string representation of this interval.

__contains__

Operator overloading for LSInterval.contains().

__len__

Returns the number of elements in this interval (same result as LSInterval.count()).

__iter__

Returns an iterator for the content of this interval.

Instance methods

LSInterval.is_void()

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.

Return type

bool

LSInterval.is_degenerate()

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.

Return type

bool

LSInterval.start()

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.

Return type

int

LSInterval.end()

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.

Return type

int

LSInterval.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.

Return type

int

LSInterval.contains(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.

Return type

bool

Special operators and methods

LSInterval.__str__()

Returns a string representation of this interval.

Returns

String representation of this interval.

Return type

str

LSInterval.__contains__(value)

Operator overloading for LSInterval.contains().

Returns

True if the interval contains the value.

Return type

bool

LSInterval.__len__()

Returns the number of elements in this interval (same result as LSInterval.count()).

Returns

Number of elements in the interval.

Return type

int

LSInterval.__iter__()

Returns an iterator for the content of this interval.