Package org.clafer.ir

This package provides the IR used as in intermediate language during compilation.

See: Description

Interface Summary

Interface	Description
IrBoolExpr	An immutable expression that evaluates to a boolean.
IrBoolExprVisitor<A,B>	Dynamic dispatch for IR boolean expressions.
IrConstant
IrDomain	Integer domain.
IrExpr	An immutable expression.
IrIntExpr	An immutable expression that evaluates to an integer.
IrIntExprVisitor<A,B>	Dynamic dispatch for IR integer expressions.
IrSetExpr	An immutable expression that evaluates to a set of integers.
IrSetExprVisitor<A,B>	Dynamic dispatch for IR set expressions.
IrVar	A variable.

Class Summary

Class	Description
IrAbstractBool
IrAbstractInt
IrAbstractSet
IrAcyclic
IrAdd	offset + foldl (+) addends
IrAllDifferent
IrAnd
IrArrayToSet
IrBoolChannel
IrBoolConstant
IrBoolExprVisitorAdapter<A,B>
IrBoolVar
IrBoundDomain	A contiguous domain between a low and high bound.
IrCard
IrCompare	left `op` right + offset
IrCount
IrDiv	dividend / divisor
IrElement	Returns array[index].
IrEmptyDomain	A domain of size 0.
IrEnumDomain	A domain over explicitly defined values.
IrFilterString
IrIfOnlyIf
IrIfThenElse
IrImplies
IrIntChannel
IrIntConstant
IrIntVar
IrJoinFunction
IrJoinRelation
IrLone
IrMask
IrMember
IrMinus
IrModule	The compiled model in IR.
IrMul	multiplicant * multiplier
IrNot
IrNotImplies
IrNotMember
IrNotWithin
IrOffset
IrOne
IrOr
IrRewriter<T>
Irs	Import this class to access all IR building functions.
IrSelectN
IrSetConstant
IrSetDifference
IrSetIntersection
IrSetSum
IrSetTernary
IrSetTest
IrSetUnion
IrSetVar
IrSingleton
IrSortSets
IrSortStrings
IrSortStringsChannel
IrSubsetEq
IrTernary
IrUnreachable
IrUtil
IrWithin
IrXor

Enum Summary

Enum	Description
IrBoolDomain	Boolean domain.
IrCompare.Op
IrSetTest.Op
IrUtil.Ordering

Exception Summary

Exception	Description
IrException

Package org.clafer.ir Description

This package provides the IR used as in intermediate language during compilation. AST -> IR -> Choco

It resembles the Choco API except for two facts.

1. Boolean expressions in the IR unify Choco Constraints, BoolVars, and LogOps. The IR will try to optimally compile to whichever Choco construct is most efficient.
2. Expressions can be nested. In Choco, expressions cannot be nested. This simplifies compiling the AST since expressions are Clafer are nested. Having expressions nested makes optimization easier, before it is flattened into Choco.

The IR is designed to make optimization easy at the expense of being harder to use. The IR is internal, and most use cases should not use this package. Use the org.clafer.compiler package to go straight from AST to IR.

The IR has 3 types: booleans, integers, and sets of integers. Each variable and expression typed.

Author:

jimmy