Package jsetl

Class LVar

java.lang.Object

jsetl.LObject

jsetl.LVar

Direct Known Subclasses:

BoolLVar, IntLVar, SetLVar

public class LVar
extends LObject

This class provides implementation for logical variables. logical variables may be initialized with any value. logical variables may be un-initialized.

Field Summary

Fields inherited from class jsetl.LObject

USEJOLLYTOKEN

Constructor Summary

Constructors

Constructor	Description
LVar()	Constructs a not initialized logical variable with default name.
LVar(java.lang.Object value)	Constructs an initialized logical variable with given value and default name.
LVar(java.lang.String name)	Constructs a not initialized logical variable with a specified name.
LVar(java.lang.String name, java.lang.Object value)	Constructs an initialized logical variable with given value and name.
LVar(java.lang.String name, LVar lVar)	Constructs a logical variable equal to the logical variable lVar and with a specified name.
LVar(LVar lVar)	Constructs a logical variable equal to the logical variable lVar.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(jsetl.Visitor visitor)	Needed for the visitor pattern.
LVar	clone()	Creates and returns a (bit-by-bit) copy of this object.
Constraint	eq(java.lang.Object object)	Constructs and returns a new constraint which demands that this is equal to object
boolean	equals(java.lang.Object object)	Tests if this logical variable is equal to the given object.
java.lang.Object	getValue()	Gets the value of this LVar or null if the variable is not initialized.
boolean	isGround()	Returns true if the invocation object is ground, false if it isn't.
Constraint	neq(java.lang.Object object)	Constructs and returns a new constraint which demands that this is not equal to object.
LVar	setName(java.lang.String name)	Sets the name of this logical variable and returns the logical variable
LVar	setValue(java.lang.Object object)	Sets the value of this LVar to the parameter object.
java.lang.String	toString()	Returns a string corresponding to the logical variable value.

Methods inherited from class jsetl.LObject

getName, in, in, isBound, isGround, nin, nin, output

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LVar

public LVar()

Constructs a not initialized logical variable with default name.

LVar

public LVar(@NotNull
            java.lang.String name)

Constructs a not initialized logical variable with a specified name.

Parameters:

name - name of the variable.

LVar

public LVar(@NotNull
            java.lang.Object value)

Constructs an initialized logical variable with given value and default name. Using this constructor is equivalent to creating a new unbound logical variable and solving the constraint this.eq(value).

Parameters:

value - value of the logical variable.

LVar

public LVar(@NotNull
            java.lang.String name,
            @NotNull
            java.lang.Object value)

Constructs an initialized logical variable with given value and name.

Parameters:

name - name of the logical variable.

value - value of the logical variable.

LVar

public LVar(@NotNull
            LVar lVar)

Constructs a logical variable equal to the logical variable lVar. The constructed logical variable has a default name. Using this constructor is equivalent to creating a new unbound logical variable and solving the constraint this.eq(lVar).

Parameters:

lVar - the logical variable to which this is equal to.

LVar

public LVar(@NotNull
            java.lang.String name,
            @NotNull
            LVar lVar)

Constructs a logical variable equal to the logical variable lVar and with a specified name. Using this constructor is equivalent to creating a new unbound logical variable and solving the constraint this.eq(lVar).

Parameters:

name - name of the logical variable.

lVar - the logical variable to which this is equal to.

Method Detail

clone

@NotNull
public LVar clone()

Creates and returns a (bit-by-bit) copy of this object.

Returns:

the cloned logical variable.

equals

public boolean equals(@Nullable
                      java.lang.Object object)

Tests if this logical variable is equal to the given object. Returns true if and only if object is a reference to this or to a logical variable that is bound to this or is an object that is equal to the value of this logical variable.

Overrides:

equals in class java.lang.Object

Parameters:

object - object to check for equality.

Returns:

true if this and object are equal, false otherwise.

getValue

@Nullable
public java.lang.Object getValue()

Gets the value of this LVar or null if the variable is not initialized.

Specified by:

getValue in class LObject

Returns:

the value of this LVar.

setName

@NotNull
public LVar setName(@NotNull
                    java.lang.String name)

Sets the name of this logical variable and returns the logical variable

Overrides:

setName in class LObject

Parameters:

name - the new name for this logical variable.

Returns:

this logical variable modified as above.

toString

@NotNull
public java.lang.String toString()

Returns a string corresponding to the logical variable value. If this logical variable is initialized this method converts its value to a string, otherwise it generates its name with "_" as prefix in order to distinguish its name from each string or character used as variable values.

Overrides:

toString in class java.lang.Object

Returns:

the computed string representation of this logical variable

setValue

@NotNull
public LVar setValue(@NotNull
                     java.lang.Object object)

Sets the value of this LVar to the parameter object.

Parameters:

object - the new value of this logical variable

Returns:

this LVar modified.

isGround

public boolean isGround()

Returns true if the invocation object is ground, false if it isn't.

Specified by:

isGround in class LObject

Returns:

true if the object is ground, false otherwise.

accept

@Nullable
public java.lang.Object accept(@NotNull
                               jsetl.Visitor visitor)

Needed for the visitor pattern.

Parameters:

visitor - the visitor that wants to visit the object.

Returns:

the result of visitor.visit(this).

eq

@NotNull
public Constraint eq(@NotNull
                     java.lang.Object object)

Constructs and returns a new constraint which demands that this is equal to object

Parameters:

object - the other parameter of the constraint.

Returns:

the constructed constraint conjunction.

neq

@NotNull
public Constraint neq(@NotNull
                      java.lang.Object object)

Constructs and returns a new constraint which demands that this is not equal to object.

Parameters:

object - the other parameter of the constraint.

Returns:

the constructed constraint conjunction.