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.tools;
31
32 import org.sat4j.specs.IVecInt;
33
34 /**
35 * Allows the end user to react when a new solution is found. This is typically
36 * the case when doing some upper bound optimization, or iterating on the
37 * models, or computing all MUses.
38 *
39 * @author leberre
40 * @since 2.3.3
41 *
42 */
43 public interface SolutionFoundListener {
44
45 SolutionFoundListener VOID = new SolutionFoundListener() {
46
47 public void onSolutionFound(int[] model) {
48 // do nothing
49 }
50
51 public void onSolutionFound(IVecInt solution) {
52 // do nothing
53 }
54
55 public void onUnsatTermination() {
56 // do nothing
57 }
58 };
59
60 /**
61 * Callback method called when a new solution is found. While a solution
62 * will often be a model, it might also be the case that the solution is
63 * something else (MUS, group MUS, etc).
64 *
65 * @param solution
66 * a set of Dimacs literals.
67 */
68 void onSolutionFound(int[] solution);
69
70 /**
71 * Callback method called when a new solution is found. While a solution
72 * will often be a model, it might also be the case that the solution is
73 * something else (MUS, group MUS, etc).
74 *
75 * @param solution
76 * a set of Dimacs literals.
77 */
78 void onSolutionFound(IVecInt solution);
79
80 /**
81 * Callback method called when the search is finished (either unsat problem
82 * or no more solutions found)
83 */
84 void onUnsatTermination();
85 }