1 /*******************************************************************************
2 * SAT4J: a SATisfiability library for Java Copyright (C) 2004, 2012 Artois University and CNRS
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 * Contributors:
28 * CRIL - initial API and implementation
29 *******************************************************************************/
30 package org.sat4j.minisat.core;
31
32 import org.sat4j.specs.ContradictionException;
33 import org.sat4j.specs.IVec;
34 import org.sat4j.specs.IVecInt;
35 import org.sat4j.specs.UnitPropagationListener;
36
37 /**
38 * The aim of the factory is to provide a concrete implementation of clauses,
39 * cardinality constraints and pseudo boolean consraints.
40 *
41 * @author leberre
42 */
43 public interface DataStructureFactory {
44
45 /**
46 * @param literals
47 * a set of literals using Dimacs format (signed non null
48 * integers).
49 * @return null if the constraint is a tautology.
50 * @throws ContradictionException
51 * the constraint is trivially unsatisfiable.
52 * @throws UnsupportedOperationException
53 * there is no concrete implementation for that constraint.
54 */
55 Constr createClause(IVecInt literals) throws ContradictionException;
56
57 Constr createUnregisteredClause(IVecInt literals);
58
59 void learnConstraint(Constr constr);
60
61 /**
62 * Create a cardinality constraint of the form sum li >= degree.
63 *
64 * @param literals
65 * a set of literals.
66 * @param degree
67 * the degree of the cardinality constraint.
68 * @return a constraint stating that at least degree literals are satisfied.
69 * @throws ContradictionException
70 */
71 Constr createCardinalityConstraint(IVecInt literals, int degree)
72 throws ContradictionException;
73
74 Constr createUnregisteredCardinalityConstraint(IVecInt literals, int degree);
75
76 void setUnitPropagationListener(UnitPropagationListener s);
77
78 void setLearner(Learner l);
79
80 void reset();
81
82 ILits getVocabulary();
83
84 /**
85 * @param p
86 * @return a vector containing all the objects to be notified of the
87 * satisfaction of that literal.
88 */
89 IVec<Propagatable> getWatchesFor(int p);
90
91 /**
92 * @param p
93 * @param i
94 * the index of the conflicting constraint
95 */
96 void conflictDetectedInWatchesFor(int p, int i);
97 }