public class BoolLVar extends LVar
USEJOLLYTOKEN
Constructor | Description |
---|---|
BoolLVar() |
Constructs an uninitialized boolean logical variable with an empty constraint associated and default name.
|
BoolLVar(boolean bool) |
Constructs a boolean logical variable initialized with the value
bool and with an empty constraint associated. |
BoolLVar(java.lang.String name) |
Constructs an uninitialized boolean logical variable with the given
name and with an empty constraint associated. |
BoolLVar(java.lang.String name,
boolean bool) |
Constructs a boolean logical variable initialized with the value
bool
and with an empty constraint associated and with the given name. |
BoolLVar(java.lang.String name,
BoolLVar boolLVar) |
Constructs a boolean logical variable which is a equal to the parameter
boolLVar with the given name. |
BoolLVar(BoolLVar boolLVar) |
Constructs a boolean logical variable which is a equal to the parameter
boolLVar with default name. |
Modifier and Type | Method | Description |
---|---|---|
java.lang.Object |
accept(jsetl.Visitor visitor) |
Needed for the visitor pattern.
|
BoolLVar |
and(BoolLVar other) |
Creates and returns a boolean logical variable which is the result of the expression
this and other . |
BoolLVar |
clone() |
Creates and returns a bit-by-bit copy of the variable.
|
Constraint |
eq(java.lang.Boolean bool) |
Creates and returns a constraint which represents the equality between
this and the parameter bool
The constraint created and returned contains the constraints in the field constraint of this . |
Constraint |
eq(BoolLVar other) |
Creates and returns a constraint which represents the equality between
this and the parameter other
The constraint created and returned contains the constraints in the field constraint of both this and other |
Constraint |
getConstraint() |
Returns the constraint conjunction associated with this variable.
|
java.lang.Boolean |
getValue() |
Gets the value of the variable.
|
BoolLVar |
iff(BoolLVar other) |
Creates and returns a boolean logical variable which is the result of the expression
this iff other . |
BoolLVar |
implies(BoolLVar other) |
Creates and returns a boolean logical variable which is the result of the expression
this implies other . |
boolean |
isFalse() |
Tests whether the value is false or not.
|
boolean |
isTrue() |
Tests whether the value is true or not.
|
Constraint |
label() |
Constructs and returns a new constraint conjunction which tells the solver to label the object.
|
static Constraint |
label(java.util.List<BoolLVar> list) |
Constructs and returns a new constraint conjunction which tells the solver to label the boolean logical variables in
list . |
Constraint |
label(BoolHeuristic boolHeuristic) |
Constructs and returns a new constraint conjunction which tells the solver to label the object using the given heuristic.
|
static Constraint |
label(BoolLVar... boolLVars) |
Constructs and returns a new constraint conjunction which tells the solver to label the boolean logical variables in
boolLVars . |
Constraint |
label(LabelingOptions labelingOptions) |
Constructs and returns a new constraint conjunction which tells the solver to label the object using the given labeling options.
|
static Constraint |
label(LabelingOptions labelingOptions,
java.util.List<BoolLVar> list) |
Constructs and returns a new constraint conjunction which tells the solver to label the boolean logical variables in
list
using the given labeling options. |
static Constraint |
label(LabelingOptions labelingOptions,
BoolLVar... boolLVars) |
Constructs and returns a new constraint conjunction which tells the solver to label the boolean logical variables in
boolLVars
using the given labeling options. |
Constraint |
neq(java.lang.Boolean bool) |
Creates and returns a constraint which represents the inequality between
this and the parameter bool
The constraint created and returned contains the constraints in the field constraint of this . |
Constraint |
neq(BoolLVar other) |
Creates and returns a constraint which represents the inequality between
this and the parameter other
The constraint created and returned contains the constraints in the field constraint of both this and other . |
BoolLVar |
not() |
Creates and returns a boolean logical variable which is the result of the expression not(
this ) . |
BoolLVar |
or(BoolLVar other) |
Creates and returns a boolean logical variable which is the result of the expression
this or other . |
void |
output() |
Outputs to standard output a description of the variable,
including its name if uninitialized (or value otherwise) and its associated constraint.
|
BoolLVar |
setName(java.lang.String name) |
Sets the name of the variable to the given name and then returns the variable.
|
public BoolLVar()
public BoolLVar(@NotNull java.lang.String name)
name
and with an empty constraint associated.name
- the name of the variable.public BoolLVar(boolean bool)
bool
and with an empty constraint associated.bool
- the value to give to the variable.public BoolLVar(@NotNull java.lang.String name, boolean bool)
bool
and with an empty constraint associated and with the given name.name
- the name of the variable.bool
- the value to give to the variable.public BoolLVar(@NotNull BoolLVar boolLVar)
boolLVar
with default name.
Using this constructor is equivalent to creating an unbound variable and the bounding it to boolLVar
solving the constraint this.eq(boolLVar)
.boolLVar
- the constructed variable will be bound to this parameter.public BoolLVar(@NotNull java.lang.String name, @NotNull BoolLVar boolLVar)
boolLVar
with the given name.
Using this constructor is equivalent to creating an unbound variable and the bounding it to boolLVar
solving the constraint this.eq(boolLVar)
.name
- the name of the variableboolLVar
- the constructed variable will be bound to this parameter.@NotNull public static Constraint label(@NotNull java.util.List<BoolLVar> list)
list
.list
- a list of boolean logical variables to label. None of them can be null
.list
.java.lang.NullPointerException
- if one of the boolean logical variables in list
is null
.@NotNull public static Constraint label(@NotNull LabelingOptions labelingOptions, @NotNull java.util.List<BoolLVar> list)
list
using the given labeling options.labelingOptions
- the labeling options to use when labeling the boolean logical variables.list
- a list of boolean logical variables to label. None of them can be null
.list
using the given labeling options.java.lang.NullPointerException
- if one of the boolean logical variables in list
is null
.@NotNull public static Constraint label(@NotNull BoolLVar... boolLVars)
boolLVars
.boolLVars
- an array containing the boolean logical variables to label. None of them can be null
.boolLVars
.java.lang.NullPointerException
- if one of the boolean logical variables in list
is null
.@NotNull public static Constraint label(@NotNull LabelingOptions labelingOptions, @NotNull BoolLVar... boolLVars)
boolLVars
using the given labeling options.labelingOptions
- the labeling options to use when labeling the boolean logical variables.boolLVars
- an array containing boolean logical variables to label. None of them can be null
.boolLVars
using the given labeling options.java.lang.NullPointerException
- if one of the boolean logical variables in list
is null
.@Nullable public java.lang.Boolean getValue()
@NotNull public BoolLVar setName(@NotNull java.lang.String name)
@Nullable public java.lang.Object accept(@NotNull jsetl.Visitor visitor)
@NotNull public Constraint getConstraint()
public void output()
@NotNull public Constraint eq(@NotNull BoolLVar other)
this
and the parameter other
The constraint created and returned contains the constraints in the field constraint
of both this
and other
other
- The second argument of the equality constraint.this
and the parameter other
.@NotNull public Constraint eq(@NotNull java.lang.Boolean bool)
this
and the parameter bool
The constraint created and returned contains the constraints in the field constraint
of this
.bool
- The second argument of the equality constraint.this
and the parameter bool
.@NotNull public Constraint neq(@NotNull BoolLVar other)
this
and the parameter other
The constraint created and returned contains the constraints in the field constraint
of both this
and other
.other
- The second argument of the inequality constraint.this
and the parameter other
.public Constraint neq(@NotNull java.lang.Boolean bool)
this
and the parameter bool
The constraint created and returned contains the constraints in the field constraint
of this
.bool
- The second argument of the inequality constraint.this
and the parameter bool
.@NotNull public BoolLVar and(@NotNull BoolLVar other)
this
and other
.
The result of the expression contains a constraint conjunction which is the conjunction of this.constraint
and other.constraint
with the atomic constraint result = this AND other.other
- The second argument of the and expression.this
and other
.@NotNull public BoolLVar or(@NotNull BoolLVar other)
this
or other
.
The result of the expression contains a constraint conjunction which is the conjunction of this.constraint
and other.constraint
with the atomic constraint result = this || other.other
- The second argument of the or expression.this
or other
.@NotNull public BoolLVar implies(@NotNull BoolLVar other)
this
implies other
.
The result of the expression contains a constraint conjunction which is the conjunction of this.constraint
and other.constraint
with the atomic constraint result = this implies other.other
- The second argument of the implication.this
implies other
.@NotNull public BoolLVar iff(@NotNull BoolLVar other)
this
iff other
.
The result of the expression contains a constraint conjunction which is the conjunction of this.constraint
and other.constraint
with the atomic constraint result = this iff other.other
- The second argument of the iff.this
iff other
@NotNull public BoolLVar not()
this
) .
The result of the expression contains the constraint conjunction this.constraint
^ not(this
)this
).public boolean isTrue()
true
if the variable is initialized with value true, false
otherwise.public boolean isFalse()
true
if the variable is initialized with value false, false
otherwise.@NotNull public Constraint label()
@NotNull public Constraint label(@NotNull BoolHeuristic boolHeuristic)
boolHeuristic
- the heuristic to use when labeling the object.@NotNull public Constraint label(@NotNull LabelingOptions labelingOptions)
labelingOptions
- the labeling options to use when labeling the object.