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 Type

type lsinterval

Value type for interval expressions. Such a value is obtained with lsexpression.value or with lssolution.getValue().

See

lsmodel

See

lsexpression

Summary

Functions

isVoid

Returns true if the interval is void.

isDegenerate

Returns true if the interval is degenerate.

getStart

Returns the start of the interval.

getEnd

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.

toString

Returns a string representation of the interval.

Functions

lsinterval.isVoid(val)

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

Returns

True if the interval is degenerate.

Return type

bool

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

Return type

int

lsinterval.getEnd(value)

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(value)

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(lsint 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

lsinterval.toString(value)

Returns a string representation of the interval.

Returns

String representation.

Return type

string