org.sat4j.minisat.constraints.cnf
Class CBClause

java.lang.Object
  org.sat4j.minisat.constraints.cnf.CBClause

All Implemented Interfaces:

java.io.Serializable, Constr, Propagatable, Undoable, IConstr

Direct Known Subclasses:

MixableCBClause

public class CBClause
extends java.lang.Object
implements Constr, Undoable, java.io.Serializable

Author:

leberre

See Also:

Serialized Form

Field Summary

protected int	falsified
protected int[]	lits
protected ILits	voc

Constructor Summary

CBClause(IVecInt ps, ILits voc)

CBClause(IVecInt ps, ILits voc, boolean learnt)

Method Summary

void	assertConstraint(UnitPropagationListener s) Method called when the constraint is to be asserted.
static CBClause	brandNewClause(UnitPropagationListener s, ILits voc, IVecInt literals)
void	calcReason(int p, IVecInt outReason) Compute the reason for a given assignment.
int	get(int i) returns the ith literal in the constraint
double	getActivity() To obtain the activity of the constraint.
void	incActivity(double claInc) Increase the constraint activity.
boolean	learnt()
boolean	locked() Indicate wether a constraint is responsible from an assignment.
boolean	propagate(UnitPropagationListener s, int p) Propagate the truth value of a literal in constraints in which that literal is falsified.
void	register() Register the constraint to the solver.
void	remove() Remove a constraint from the solver.
void	rescaleBy(double d) Rescale the clause activity by a value.
void	setLearnt() Mark a constraint as learnt.
boolean	simplify() Simplifies a constraint, by removing top level falsified literals for instance.
int	size()
java.lang.String	toString()
void	undo(int p) Method called when backtracking

Methods inherited from class java.lang.Object

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

Field Detail

falsified

protected int falsified

lits

protected final int[] lits

voc

protected final ILits voc

Constructor Detail

CBClause

public CBClause(IVecInt ps,
                ILits voc,
                boolean learnt)

CBClause

public CBClause(IVecInt ps,
                ILits voc)

Method Detail

brandNewClause

public static CBClause brandNewClause(UnitPropagationListener s,
                                      ILits voc,
                                      IVecInt literals)

remove

public void remove()

Description copied from interface: Constr

Remove a constraint from the solver.

Specified by:

remove in interface Constr

propagate

public boolean propagate(UnitPropagationListener s,
                         int p)

Description copied from interface: Propagatable

Propagate the truth value of a literal in constraints in which that literal is falsified.

Specified by:

propagate in interface Propagatable

Parameters:

s - something able to perform unit propagation

p - the literal being propagated. Its negation must appear in the constraint.

Returns:

false iff an inconsistency (a contradiction) is detected.

simplify

public boolean simplify()

Description copied from interface: Constr

Simplifies a constraint, by removing top level falsified literals for instance.

Specified by:

simplify in interface Constr

Returns:

true iff the constraint is satisfied.

undo

public void undo(int p)

Description copied from interface: Undoable

Method called when backtracking

Specified by:

undo in interface Undoable

Parameters:

p - a literal to be unassigned.

calcReason

public void calcReason(int p,
                       IVecInt outReason)

Description copied from interface: Constr

Compute the reason for a given assignment. If the constraint is a clause, it is supposed to be either a unit clause or a falsified one.

Specified by:

calcReason in interface Constr

Parameters:

p - a satisfied literal (or Lit.UNDEFINED)

outReason - the list of falsified literals whose negation is the reason of the assignment of p to true.

learnt

public boolean learnt()

Specified by:

learnt in interface IConstr

Returns:

true iff the clause was learnt during the search

incActivity

public void incActivity(double claInc)

Description copied from interface: Constr

Increase the constraint activity.

Specified by:

incActivity in interface Constr

Parameters:

claInc - the value to increase the activity with

getActivity

public double getActivity()

Description copied from interface: Constr

To obtain the activity of the constraint.

Specified by:

getActivity in interface Constr

Returns:

the activity of the clause.

locked

public boolean locked()

Description copied from interface: Constr

Indicate wether a constraint is responsible from an assignment.

Specified by:

locked in interface Constr

Returns:

true if a constraint is a "reason" for an assignment.

setLearnt

public void setLearnt()

Description copied from interface: Constr

Mark a constraint as learnt.

Specified by:

setLearnt in interface Constr

register

public void register()

Description copied from interface: Constr

Register the constraint to the solver.

Specified by:

register in interface Constr

rescaleBy

public void rescaleBy(double d)

Description copied from interface: Constr

Rescale the clause activity by a value.

Specified by:

rescaleBy in interface Constr

Parameters:

d - the value to rescale the clause activity with.

size

public int size()

Specified by:

size in interface IConstr

Returns:

the number of literals in the constraint.

get

public int get(int i)

Description copied from interface: IConstr

returns the ith literal in the constraint

Specified by:

get in interface IConstr

Parameters:

i - the index of the literal

Returns:

a literal

assertConstraint

public void assertConstraint(UnitPropagationListener s)

Description copied from interface: Constr

Method called when the constraint is to be asserted. It means that the constraint was learnt during the search and it should now propagate some truth values. In the clausal case, only one literal should be propagated. In other cases, it might be different.

Specified by:

assertConstraint in interface Constr

Parameters:

s - a UnitPropagationListener to use for unit propagation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object