jp.kobe_u.sugar.csp

Class IntegerVariable

java.lang.Object

jp.kobe_u.sugar.csp.IntegerVariable

All Implemented Interfaces:

java.lang.Comparable<IntegerVariable>

public class IntegerVariable
extends java.lang.Object
implements java.lang.Comparable<IntegerVariable>

This class implements an integer variable of CSP.

See Also:

CSP

Constructor Summary

Constructors

Constructor and Description
IntegerVariable(IntegerDomain domain)
IntegerVariable(java.lang.String name, IntegerDomain domain)

Method Summary

Modifier and Type	Method and Description
int	bound(int lb, int ub)
int	compareTo(IntegerVariable v)
void	decode(java.util.BitSet satValues)
boolean	equals(java.lang.Object obj)
int	getCode() Returns the code value in the encoded representation.
java.lang.String	getComment() Returns the comment set to the integer variable.
IntegerDomain	getDomain()
java.util.List<Clause>	getDomainClauses()
Encoding	getEncoding()
java.lang.String	getName() Returns the name of the integer variable.
int	getSatVariablesSize()
int	getValue() Returns the value of the integer variable.
int	hashCode()
boolean	isAux() Returns true when the integer variable is aux.
boolean	isBoolean()
boolean	isDominant()
boolean	isModified()
boolean	isPbEncoding()
boolean	isSatisfied() Returns true when the value is within the bounds.
boolean	isUnsatisfiable()
void	setCode(int code) Sets the code value in the encoded representation.
void	setComment(java.lang.String comment) Sets the comment to the integer variable.
void	setDominant(boolean dominant)
void	setEncoding(Encoding encoding)
void	setModified(boolean modified)
void	setValue(int value) Sets the value of the integer variable.
java.lang.String	toString() Returns the string representation of the integer variable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerVariable

public IntegerVariable(java.lang.String name,
                       IntegerDomain domain)
                throws SugarException

Throws:

SugarException

IntegerVariable

public IntegerVariable(IntegerDomain domain)
                throws SugarException

Throws:

SugarException

Method Detail

getName

public java.lang.String getName()

Returns the name of the integer variable.

Returns:

the name

getDomain

public IntegerDomain getDomain()

isAux

public boolean isAux()

Returns true when the integer variable is aux.

Returns:

true when the integer variable is aux

getComment

public java.lang.String getComment()

Returns the comment set to the integer variable.

Returns:

the comment

setComment

public void setComment(java.lang.String comment)

Sets the comment to the integer variable.

Parameters:

comment - the comment to set

isModified

public boolean isModified()

Returns:

the modified

setModified

public void setModified(boolean modified)

Parameters:

modified - the modified to set

bound

public int bound(int lb,
                 int ub)
          throws SugarException

Throws:

SugarException

getCode

public int getCode()

Returns the code value in the encoded representation.

Returns:

the code value in the encoded representation

setCode

public void setCode(int code)

Sets the code value in the encoded representation.

Parameters:

code - the code value

isDominant

public boolean isDominant()

setDominant

public void setDominant(boolean dominant)

getEncoding

public Encoding getEncoding()

setEncoding

public void setEncoding(Encoding encoding)

isPbEncoding

public boolean isPbEncoding()

isBoolean

public boolean isBoolean()

getValue

public int getValue()

Returns the value of the integer variable.

Returns:

the value

setValue

public void setValue(int value)

Sets the value of the integer variable.

Parameters:

value - the value to set

isUnsatisfiable

public boolean isUnsatisfiable()

isSatisfied

public boolean isSatisfied()

Returns true when the value is within the bounds.

Returns:

true when the value is within the bounds

getSatVariablesSize

public int getSatVariablesSize()

getDomainClauses

public java.util.List<Clause> getDomainClauses()

decode

public void decode(java.util.BitSet satValues)

compareTo

public int compareTo(IntegerVariable v)

Specified by:

compareTo in interface java.lang.Comparable<IntegerVariable>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Returns the string representation of the integer variable.

Overrides:

toString in class java.lang.Object

Returns:

the string representation