View Javadoc

1   /*******************************************************************************
2    * SAT4J: a SATisfiability library for Java Copyright (C) 2004-2008 Daniel Le Berre
3    *
4    * All rights reserved. This program and the accompanying materials
5    * are made available under the terms of the Eclipse Public License v1.0
6    * which accompanies this distribution, and is available at
7    * http://www.eclipse.org/legal/epl-v10.html
8    *
9    * Alternatively, the contents of this file may be used under the terms of
10   * either the GNU Lesser General Public License Version 2.1 or later (the
11   * "LGPL"), in which case the provisions of the LGPL are applicable instead
12   * of those above. If you wish to allow use of your version of this file only
13   * under the terms of the LGPL, and not to allow others to use your version of
14   * this file under the terms of the EPL, indicate your decision by deleting
15   * the provisions above and replace them with the notice and other provisions
16   * required by the LGPL. If you do not delete the provisions above, a recipient
17   * may use your version of this file under the terms of the EPL or the LGPL.
18   * 
19   * Based on the original MiniSat specification from:
20   * 
21   * An extensible SAT solver. Niklas Een and Niklas Sorensson. Proceedings of the
22   * Sixth International Conference on Theory and Applications of Satisfiability
23   * Testing, LNCS 2919, pp 502-518, 2003.
24   *
25   * See www.minisat.se for the original solver in C++.
26   * 
27   *******************************************************************************/
28  package org.sat4j.minisat.core;
29  
30  import org.sat4j.specs.ContradictionException;
31  import org.sat4j.specs.IVec;
32  import org.sat4j.specs.IVecInt;
33  
34  /**
35   * The aim of the factory is to provide a concrete implementation of clauses,
36   * cardinality constraints and pseudo boolean consraints.
37   * 
38   * @author leberre
39   */
40  public interface DataStructureFactory {
41  
42  	/**
43  	 * @param literals
44  	 *            a set of literals using Dimacs format (signed non null
45  	 *            integers).
46  	 * @return null if the constraint is a tautology.
47  	 * @throws ContradictionException
48  	 *             the constraint is trivially unsatisfiable.
49  	 * @throws UnsupportedOperationException
50  	 *             there is no concrete implementation for that constraint.
51  	 */
52  	Constr createClause(IVecInt literals) throws ContradictionException;
53  
54  	Constr createUnregisteredClause(IVecInt literals);
55  
56  	void learnConstraint(Constr constr);
57  
58  	/**
59  	 * Create a cardinality constraint of the form sum li >= degree.
60  	 * 
61  	 * @param literals
62  	 *            a set of literals.
63  	 * @param degree
64  	 *            the degree of the cardinality constraint.
65  	 * @return a constraint stating that at least degree literals are satisfied.
66  	 * @throws ContradictionException
67  	 */
68  	Constr createCardinalityConstraint(IVecInt literals, int degree)
69  			throws ContradictionException;
70  
71  	void setUnitPropagationListener(UnitPropagationListener s);
72  
73  	void setLearner(Learner l);
74  
75  	void reset();
76  
77  	ILits getVocabulary();
78  
79  	/**
80  	 * @param p
81  	 * @return a vector containing all the objects to be notified of the
82  	 *         satisfaction of that literal.
83  	 */
84  	IVec<Propagatable> getWatchesFor(int p);
85  
86  	/**
87  	 * @param p
88  	 * @param i
89  	 *            the index of the conflicting constraint
90  	 */
91  	void conflictDetectedInWatchesFor(int p, int i);
92  }