HxInterval Class

class HxInterval

Value type for interval expressions. Such value is obtained with HxExpression::getIntervalValue() or HxSolution::getIntervalValue().

See:

HxSolution

See:

HxExpression

Since:

12.0

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

bool HxInterval::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.

bool HxInterval::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.

hxint HxInterval::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.

hxint HxInterval::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.

hxint HxInterval::count() const

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.

bool HxInterval::contains(hxint value) const

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.

std::string HxInterval::toString() const

Returns a string representation of the interval.

Returns:

String representation.