Package org.sosy_lab.java_smt.basicimpl

Class AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv,TFuncDecl>

java.lang.Object

org.sosy_lab.java_smt.basicimpl.AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv,TFuncDecl>

All Implemented Interfaces:

BitvectorFormulaManager

public abstract class AbstractBitvectorFormulaManager<TFormulaInfo,TType,TEnv,TFuncDecl>
extends Object
implements BitvectorFormulaManager

Field Summary

Fields

Modifier and Type	Field	Description
protected FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl>	formulaCreator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBitvectorFormulaManager(FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl> pCreator, AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv,TFuncDecl> pBmgr)

Method Summary

Modifier and Type	Method	Description
BitvectorFormula	add(BitvectorFormula pNumber1, BitvectorFormula pNumber2)
protected abstract TFormulaInfo	add(TFormulaInfo pParam1, TFormulaInfo pParam2)
BitvectorFormula	and(BitvectorFormula pBits1, BitvectorFormula pBits2)	Creates a formula representing an AND of the two arguments.
protected abstract TFormulaInfo	and(TFormulaInfo pParam1, TFormulaInfo pParam2)
BitvectorFormula	concat(BitvectorFormula pNumber, BitvectorFormula pAppend)
protected abstract TFormulaInfo	concat(TFormulaInfo number, TFormulaInfo pAppend)
BooleanFormula	distinct(List<BitvectorFormula> pBits)	All given bitvectors are pairwise unequal.
protected TFormulaInfo	distinctImpl(List<TFormulaInfo> pBits)
BitvectorFormula	divide(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	divide(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BooleanFormula	equal(BitvectorFormula pNumber1, BitvectorFormula pNumber2)
protected abstract TFormulaInfo	equal(TFormulaInfo pParam1, TFormulaInfo pParam2)
BitvectorFormula	extend(BitvectorFormula pNumber, int pExtensionBits, boolean pSigned)	Extend a bitvector to the left (add most significant bits).
protected abstract TFormulaInfo	extend(TFormulaInfo pNumber, int pExtensionBits, boolean pSigned)
BitvectorFormula	extract(BitvectorFormula pNumber, int pMsb, int pLsb, boolean pSigned)
protected abstract TFormulaInfo	extract(TFormulaInfo pNumber, int pMsb, int pLsb, boolean pSigned)
protected FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl>	getFormulaCreator()
int	getLength(BitvectorFormula pNumber)
BooleanFormula	greaterOrEquals(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	greaterOrEquals(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BooleanFormula	greaterThan(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	greaterThan(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BooleanFormula	lessOrEquals(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	lessOrEquals(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BooleanFormula	lessThan(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	lessThan(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BitvectorFormula	makeBitvector(int pLength, long i)	Convert a number into a bitvector with given size.
BitvectorFormula	makeBitvector(int pLength, BigInteger i)	Convert a number into a bitvector with given size.
BitvectorFormula	makeBitvector(int length, NumeralFormula.IntegerFormula pI)	Convert/Cast a numeral formula into a bitvector with given size.
protected TFormulaInfo	makeBitvectorImpl(int pLength, long pI)
protected abstract TFormulaInfo	makeBitvectorImpl(int pLength, BigInteger pI)
protected abstract TFormulaInfo	makeBitvectorImpl(int length, TFormulaInfo pParam1)
BitvectorFormula	makeVariable(int pLength, String pVar)	Creates a variable with exactly the given name and bitwidth.
BitvectorFormula	makeVariable(FormulaType.BitvectorType type, String pVar)
protected abstract TFormulaInfo	makeVariableImpl(int pLength, String pVar)
BitvectorFormula	modulo(BitvectorFormula pNumber1, BitvectorFormula pNumber2, boolean signed)
protected abstract TFormulaInfo	modulo(TFormulaInfo pParam1, TFormulaInfo pParam2, boolean signed)
BitvectorFormula	multiply(BitvectorFormula pNumber1, BitvectorFormula pNumber2)
protected abstract TFormulaInfo	multiply(TFormulaInfo pParam1, TFormulaInfo pParam2)
BitvectorFormula	negate(BitvectorFormula pNumber)
protected abstract TFormulaInfo	negate(TFormulaInfo pParam1)
BitvectorFormula	not(BitvectorFormula pBits)	Creates a formula representing a negation of the argument.
protected abstract TFormulaInfo	not(TFormulaInfo pParam1)
BitvectorFormula	or(BitvectorFormula pBits1, BitvectorFormula pBits2)	Creates a formula representing an OR of the two arguments.
protected abstract TFormulaInfo	or(TFormulaInfo pParam1, TFormulaInfo pParam2)
BitvectorFormula	shiftLeft(BitvectorFormula pNumber, BitvectorFormula toShift)
protected abstract TFormulaInfo	shiftLeft(TFormulaInfo pExtract, TFormulaInfo pExtract2)
BitvectorFormula	shiftRight(BitvectorFormula pNumber, BitvectorFormula toShift, boolean signed)	Return a term representing the (arithmetic if signed is true) right shift of number by toShift.
protected abstract TFormulaInfo	shiftRight(TFormulaInfo pNumber, TFormulaInfo toShift, boolean signed)
BitvectorFormula	subtract(BitvectorFormula pNumber1, BitvectorFormula pNumber2)
protected abstract TFormulaInfo	subtract(TFormulaInfo pParam1, TFormulaInfo pParam2)
NumeralFormula.IntegerFormula	toIntegerFormula(BitvectorFormula pI, boolean signed)	Interpret a signed/unsigned bitvector formula as an integer formula.
protected abstract TFormulaInfo	toIntegerFormulaImpl(TFormulaInfo pI, boolean signed)
protected TType	toSolverType(FormulaType<?> formulaType)
protected BigInteger	transformValueToRange(int pLength, BigInteger pI)	transform a negative value into its positive counterpart.
BitvectorFormula	xor(BitvectorFormula pBits1, BitvectorFormula pBits2)
protected abstract TFormulaInfo	xor(TFormulaInfo pParam1, TFormulaInfo pParam2)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

formulaCreator

protected final FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl> formulaCreator

Constructor Detail

AbstractBitvectorFormulaManager

protected AbstractBitvectorFormulaManager(FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl> pCreator,
                                          AbstractBooleanFormulaManager<TFormulaInfo,TType,TEnv,TFuncDecl> pBmgr)

Method Detail

makeBitvector

public BitvectorFormula makeBitvector(int length,
                                      NumeralFormula.IntegerFormula pI)

Description copied from interface: BitvectorFormulaManager

Convert/Cast a numeral formula into a bitvector with given size.

If the numeral formula is too large for the given length, we cut off the largest bits and only use the smallest bits.

Specified by:

makeBitvector in interface BitvectorFormulaManager

makeBitvectorImpl

protected abstract TFormulaInfo makeBitvectorImpl(int length,
                                                  TFormulaInfo pParam1)

toIntegerFormula

public NumeralFormula.IntegerFormula toIntegerFormula(BitvectorFormula pI,
                                                      boolean signed)

Description copied from interface: BitvectorFormulaManager

Interpret a signed/unsigned bitvector formula as an integer formula.

Specified by:

toIntegerFormula in interface BitvectorFormulaManager

toIntegerFormulaImpl

protected abstract TFormulaInfo toIntegerFormulaImpl(TFormulaInfo pI,
                                                     boolean signed)

negate

public BitvectorFormula negate(BitvectorFormula pNumber)

Specified by:

negate in interface BitvectorFormulaManager

negate

protected abstract TFormulaInfo negate(TFormulaInfo pParam1)

add

public BitvectorFormula add(BitvectorFormula pNumber1,
                            BitvectorFormula pNumber2)

Specified by:

add in interface BitvectorFormulaManager

add

protected abstract TFormulaInfo add(TFormulaInfo pParam1,
                                    TFormulaInfo pParam2)

subtract

public BitvectorFormula subtract(BitvectorFormula pNumber1,
                                 BitvectorFormula pNumber2)

Specified by:

subtract in interface BitvectorFormulaManager

subtract

protected abstract TFormulaInfo subtract(TFormulaInfo pParam1,
                                         TFormulaInfo pParam2)

divide

public BitvectorFormula divide(BitvectorFormula pNumber1,
                               BitvectorFormula pNumber2,
                               boolean signed)

Specified by:

divide in interface BitvectorFormulaManager

divide

protected abstract TFormulaInfo divide(TFormulaInfo pParam1,
                                       TFormulaInfo pParam2,
                                       boolean signed)

modulo

public BitvectorFormula modulo(BitvectorFormula pNumber1,
                               BitvectorFormula pNumber2,
                               boolean signed)

Specified by:

modulo in interface BitvectorFormulaManager

modulo

protected abstract TFormulaInfo modulo(TFormulaInfo pParam1,
                                       TFormulaInfo pParam2,
                                       boolean signed)

multiply

public BitvectorFormula multiply(BitvectorFormula pNumber1,
                                 BitvectorFormula pNumber2)

Specified by:

multiply in interface BitvectorFormulaManager

multiply

protected abstract TFormulaInfo multiply(TFormulaInfo pParam1,
                                         TFormulaInfo pParam2)

equal

public BooleanFormula equal(BitvectorFormula pNumber1,
                            BitvectorFormula pNumber2)

Specified by:

equal in interface BitvectorFormulaManager

equal

protected abstract TFormulaInfo equal(TFormulaInfo pParam1,
                                      TFormulaInfo pParam2)

greaterThan

public BooleanFormula greaterThan(BitvectorFormula pNumber1,
                                  BitvectorFormula pNumber2,
                                  boolean signed)

Specified by:

greaterThan in interface BitvectorFormulaManager

greaterThan

protected abstract TFormulaInfo greaterThan(TFormulaInfo pParam1,
                                            TFormulaInfo pParam2,
                                            boolean signed)

greaterOrEquals

public BooleanFormula greaterOrEquals(BitvectorFormula pNumber1,
                                      BitvectorFormula pNumber2,
                                      boolean signed)

Specified by:

greaterOrEquals in interface BitvectorFormulaManager

greaterOrEquals

protected abstract TFormulaInfo greaterOrEquals(TFormulaInfo pParam1,
                                                TFormulaInfo pParam2,
                                                boolean signed)

lessThan

public BooleanFormula lessThan(BitvectorFormula pNumber1,
                               BitvectorFormula pNumber2,
                               boolean signed)

Specified by:

lessThan in interface BitvectorFormulaManager

lessThan

protected abstract TFormulaInfo lessThan(TFormulaInfo pParam1,
                                         TFormulaInfo pParam2,
                                         boolean signed)

lessOrEquals

public BooleanFormula lessOrEquals(BitvectorFormula pNumber1,
                                   BitvectorFormula pNumber2,
                                   boolean signed)

Specified by:

lessOrEquals in interface BitvectorFormulaManager

lessOrEquals

protected abstract TFormulaInfo lessOrEquals(TFormulaInfo pParam1,
                                             TFormulaInfo pParam2,
                                             boolean signed)

not

public BitvectorFormula not(BitvectorFormula pBits)

Description copied from interface: BitvectorFormulaManager

Creates a formula representing a negation of the argument.

Specified by:

not in interface BitvectorFormulaManager

Parameters:

pBits - Formula

Returns:

!f1

not

protected abstract TFormulaInfo not(TFormulaInfo pParam1)

and

public BitvectorFormula and(BitvectorFormula pBits1,
                            BitvectorFormula pBits2)

Description copied from interface: BitvectorFormulaManager

Creates a formula representing an AND of the two arguments.

Specified by:

and in interface BitvectorFormulaManager

Parameters:

pBits1 - a Formula

pBits2 - a Formula

Returns:

f1 & f2

and

protected abstract TFormulaInfo and(TFormulaInfo pParam1,
                                    TFormulaInfo pParam2)

or

public BitvectorFormula or(BitvectorFormula pBits1,
                           BitvectorFormula pBits2)

Description copied from interface: BitvectorFormulaManager

Creates a formula representing an OR of the two arguments.

Specified by:

or in interface BitvectorFormulaManager

Parameters:

pBits1 - a Formula

pBits2 - a Formula

Returns:

f1 | f2

or

protected abstract TFormulaInfo or(TFormulaInfo pParam1,
                                   TFormulaInfo pParam2)

xor

public BitvectorFormula xor(BitvectorFormula pBits1,
                            BitvectorFormula pBits2)

Specified by:

xor in interface BitvectorFormulaManager

xor

protected abstract TFormulaInfo xor(TFormulaInfo pParam1,
                                    TFormulaInfo pParam2)

makeBitvector

public BitvectorFormula makeBitvector(int pLength,
                                      long i)

Description copied from interface: BitvectorFormulaManager

Convert a number into a bitvector with given size.

Specified by:

makeBitvector in interface BitvectorFormulaManager

makeBitvectorImpl

protected TFormulaInfo makeBitvectorImpl(int pLength,
                                         long pI)

makeBitvector

public BitvectorFormula makeBitvector(int pLength,
                                      BigInteger i)

Description copied from interface: BitvectorFormulaManager

Convert a number into a bitvector with given size.

Specified by:

makeBitvector in interface BitvectorFormulaManager

makeBitvectorImpl

protected abstract TFormulaInfo makeBitvectorImpl(int pLength,
                                                  BigInteger pI)

transformValueToRange

protected final BigInteger transformValueToRange(int pLength,
                                                 BigInteger pI)

transform a negative value into its positive counterpart.

Throws:

IllegalArgumentException - if the value is out of range for the given size.

makeVariable

public BitvectorFormula makeVariable(FormulaType.BitvectorType type,
                                     String pVar)

Specified by:

makeVariable in interface BitvectorFormulaManager

See Also:

BitvectorFormulaManager.makeVariable(int, String)

makeVariable

public BitvectorFormula makeVariable(int pLength,
                                     String pVar)

Description copied from interface: BitvectorFormulaManager

Creates a variable with exactly the given name and bitwidth.

Please make sure that the given name is valid in SMT-LIB2. Take a look at FormulaManager.isValidName(java.lang.String) for further information.

This method does not quote or unquote the given name, but uses the plain name "AS IS". Formula.toString() can return a different String than the given one.

Specified by:

makeVariable in interface BitvectorFormulaManager

makeVariableImpl

protected abstract TFormulaInfo makeVariableImpl(int pLength,
                                                 String pVar)

shiftRight

public BitvectorFormula shiftRight(BitvectorFormula pNumber,
                                   BitvectorFormula toShift,
                                   boolean signed)

Return a term representing the (arithmetic if signed is true) right shift of number by toShift.

Specified by:

shiftRight in interface BitvectorFormulaManager

shiftRight

protected abstract TFormulaInfo shiftRight(TFormulaInfo pNumber,
                                           TFormulaInfo toShift,
                                           boolean signed)

shiftLeft

public BitvectorFormula shiftLeft(BitvectorFormula pNumber,
                                  BitvectorFormula toShift)

Specified by:

shiftLeft in interface BitvectorFormulaManager

shiftLeft

protected abstract TFormulaInfo shiftLeft(TFormulaInfo pExtract,
                                          TFormulaInfo pExtract2)

concat

public final BitvectorFormula concat(BitvectorFormula pNumber,
                                     BitvectorFormula pAppend)

Specified by:

concat in interface BitvectorFormulaManager

concat

protected abstract TFormulaInfo concat(TFormulaInfo number,
                                       TFormulaInfo pAppend)

extract

public final BitvectorFormula extract(BitvectorFormula pNumber,
                                      int pMsb,
                                      int pLsb,
                                      boolean pSigned)

Specified by:

extract in interface BitvectorFormulaManager

Parameters:

pNumber - The bitvector to extract.

pMsb - Upper index. Must be greater than or equal to 0 and less than the bit-width of number.

pLsb - Lower index. Must be less than or equal to msb and greater or equal to 0.

pSigned - Whether the extension should depend on the sign bit. Note: Some SMT-Solvers ignore this. (i.e. Boolector)

extract

protected abstract TFormulaInfo extract(TFormulaInfo pNumber,
                                        int pMsb,
                                        int pLsb,
                                        boolean pSigned)

extend

public final BitvectorFormula extend(BitvectorFormula pNumber,
                                     int pExtensionBits,
                                     boolean pSigned)

Description copied from interface: BitvectorFormulaManager

Extend a bitvector to the left (add most significant bits).

Specified by:

extend in interface BitvectorFormulaManager

Parameters:

pNumber - The bitvector to extend.

pExtensionBits - How many bits to add.

pSigned - Whether the extension should depend on the sign bit.

extend

protected abstract TFormulaInfo extend(TFormulaInfo pNumber,
                                       int pExtensionBits,
                                       boolean pSigned)

getLength

public int getLength(BitvectorFormula pNumber)

Specified by:

getLength in interface BitvectorFormulaManager

distinct

public final BooleanFormula distinct(List<BitvectorFormula> pBits)

Description copied from interface: BitvectorFormulaManager

All given bitvectors are pairwise unequal.

Specified by:

distinct in interface BitvectorFormulaManager

distinctImpl

protected TFormulaInfo distinctImpl(List<TFormulaInfo> pBits)

getFormulaCreator

protected final FormulaCreator<TFormulaInfo,TType,TEnv,TFuncDecl> getFormulaCreator()

toSolverType

protected final TType toSolverType(FormulaType<?> formulaType)