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 package org.sat4j.csp;
20
21 import org.sat4j.specs.ContradictionException;
22 import org.sat4j.specs.ISolver;
23
24 public interface Evaluable {
25
26 /**
27 * Return the domain of the evaluable.
28 *
29 * @return the domain of the evaluable.
30 */
31 Domain domain();
32
33 /**
34 * Translates a value from the domain into a SAT variable in Dimacs format.
35 *
36 * @param key
37 * a value from domain()
38 * @return the SAT variable associated with that value.
39 */
40 int translate(int key);
41
42 /**
43 * Translates a variable over a domain into a set a clauses enforcing that
44 * exactly one value must be chosen in the domain.
45 *
46 * @param solver
47 * a solver to feed with the clauses.
48 * @throws ContradictionException
49 * if a trivial inconsistency is met.
50 */
51 void toClause(ISolver solver) throws ContradictionException;
52
53 }