Module dev.civl.sarl

Package dev.civl.sarl.expr.IF

Interface SymbolicRangeFactory

public interface SymbolicRangeFactory

Factory for creating and manipulating SymbolicRange's.

Method Summary

Modifier and Type	Method	Description
SymbolicRange[]	diff(SymbolicRange range0, SymbolicRange range1)
BooleanExpression	disjoint(SymbolicRange range0, SymbolicRange range1)	NOTE: Currently only support ranges with a step value of 1.
BooleanExpression	equals(SymbolicRange range0, SymbolicRange range1)	NOTE: Currently only support ranges with a step value of 1.
BooleanExpression	inRange(NumericExpression expr, SymbolicRange range)
BooleanExpression	neq(SymbolicRange range0, SymbolicRange range1)	NOTE: Currently only support ranges with a step value of 1.
BooleanExpression	strictlyBelow(SymbolicRange range0, SymbolicRange range1)	NOTE: Currently only support ranges with a step value of 1.
BooleanExpression	subset(SymbolicRange range0, SymbolicRange range1)	NOTE: Currently only support ranges with a step value of 1.
SymbolicRange	symbolicRange(NumericExpression element)	Generates a new SymbolicRange which only includes "element".
SymbolicRange	symbolicRange(NumericExpression lower, NumericExpression upper)	Generates a new SymbolicRange which ranges from "lower" (inclusive) to "upper" (exclusive).
SymbolicRange	symbolicRange(NumericExpression lower, NumericExpression upper, NumericExpression step)	Generates a new SymbolicRange which ranges from "lower" (inclusive) to "upper" (exclusive) taking "step" number of steps.
SymbolicRange	tryUnion(Reasoner reasoner, SymbolicRange range0, SymbolicRange range1)	Attempts to create a single SymbolicRange which is equivalent to the union of the input SymbolicRanges range0 and range1.

Method Details

symbolicRange

SymbolicRange symbolicRange(NumericExpression element)

Generates a new SymbolicRange which only includes "element".

Parameters:

element - The expression representing the single value of this range.

Returns:

the newly created SymbolicRange

symbolicRange

SymbolicRange symbolicRange(NumericExpression lower,
 NumericExpression upper)

Generates a new SymbolicRange which ranges from "lower" (inclusive) to "upper" (exclusive).

Parameters:

lower - The expression representing the (inclusive) lower bound.

upper - The expression representing the (exclusive) upper bound.

Returns:

the newly created SymbolicRange

symbolicRange

SymbolicRange symbolicRange(NumericExpression lower,
 NumericExpression upper,
 NumericExpression step)

Generates a new SymbolicRange which ranges from "lower" (inclusive) to "upper" (exclusive) taking "step" number of steps.

Parameters:

lower - The expression representing the (inclusive) lower bound.

upper - The expression representing the (exclusive) upper bound.

step - The expression representing the step value.

Returns:

the newly created SymbolicRange

strictlyBelow

BooleanExpression strictlyBelow(SymbolicRange range0,
 SymbolicRange range1)

NOTE: Currently only support ranges with a step value of 1.

Parameters:

range0 - the first SymbolicRange

range1 - the second SymbolicRange

Returns:

A BooleanExpression which is true if the values of range0 are all strictly below the values of range1.

disjoint

BooleanExpression disjoint(SymbolicRange range0,
 SymbolicRange range1)

NOTE: Currently only support ranges with a step value of 1.

Parameters:

range0 - the first SymbolicRange

range1 - the second SymbolicRange

Returns:

A BooleanExpression which is true whenever range0 and range1 are disjoint.

subset

BooleanExpression subset(SymbolicRange range0,
 SymbolicRange range1)

NOTE: Currently only support ranges with a step value of 1.

Parameters:

range0 - the first SymbolicRange

range1 - the second SymbolicRange

Returns:

A BooleanExpression which is true whenever range0 is a subset of range1.

diff

SymbolicRange[] diff(SymbolicRange range0,
 SymbolicRange range1)

equals

BooleanExpression equals(SymbolicRange range0,
 SymbolicRange range1)

NOTE: Currently only support ranges with a step value of 1.

Parameters:

range0 - the first SymbolicRange

range1 - the second SymbolicRange

Returns:

A BooleanExpression which is true whenever range0 is equal to range1.

neq

BooleanExpression neq(SymbolicRange range0,
 SymbolicRange range1)

NOTE: Currently only support ranges with a step value of 1.

Parameters:

range0 - the first SymbolicRange

range1 - the second SymbolicRange

Returns:

A BooleanExpression which is true whenever range0 is not equal to range1.

inRange

BooleanExpression inRange(NumericExpression expr,
 SymbolicRange range)

Parameters:

expr - a NumericExpression

range - a SymbolicRange

Returns:

A BooleanExpression which is true whenever expr is an element of r.

tryUnion

SymbolicRange tryUnion(Reasoner reasoner,
 SymbolicRange range0,
 SymbolicRange range1)

Attempts to create a single SymbolicRange which is equivalent to the union of the input SymbolicRanges range0 and range1. If no such SymbolicRange can be constructed then null is returned. Optionally takes a Reasoner "reasoner" for determining potential relationships between range0 and range1. If reasoner is null then simple syntactic reasoning is used instead.

Parameters:

reasoner - the Reasoner to be used in the union process. May be null in which case simple syntactic reasoning is used.

range0 - a SymbolicRange

range1 - a SymbolicRange

Returns:

either a single SymbolicRange equivalent to the union of range0 and range1, or null if such a range could not be constructed.