org.sosy_lab.solver.api.ProverEnvironment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-smt Show documentation
Unified acccess layer to SMT solvers
There is a newer version: 5.0.1
/*
 *  JavaSMT is an API wrapper for a collection of SMT solvers.
 *  This file is part of JavaSMT.
 *
 *  Copyright (C) 2007-2015  Dirk Beyer
 *  All rights reserved.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.sosy_lab.solver.api;

import org.sosy_lab.solver.SolverException;

import java.util.List;

/**
 * An interface to an incremental SMT solver
 * with methods for pushing and popping formulas as well as sat checks.
 * Instances of this class can be used once for a series of related queries.
 * After that, the {@link #close} method should be called
 * (preferably using the try-with-resources syntax).
 * All methods are expected to throw {@link IllegalStateException}s after
 * close was called.
 *
 * All solving methods are expected to throw {@link SolverException} if the solver
 * fails to solve the given query, and {@link InterruptedException} if a thread interrupt
 * was requested or a shutdown request via the {@link org.sosy_lab.common.ShutdownNotifier}.
 * It is not guaranteed, though, that solvers respond in a timely manner (or at all)
 * to shutdown or interrupt requests.
 */
public interface ProverEnvironment extends BasicProverEnvironment {

  /**
   * Get an unsat core.
   * This should be called only immediately after an {@link #isUnsat()} call
   * that returned false.
   */
  List getUnsatCore();

  /**
   * Get all satisfying assignments of the current environment with regards
   * to a subset of terms,
   * and create a region representing all those models.
   *
   * @param important A set of variables appearing in f.
   *     Only these variables will appear in the region.
   * @return A region representing all satisfying models of the formula.
   */
   T allSat(AllSatCallback callback, List important)
      throws InterruptedException, SolverException;

  /**
   * Interface for the {@link #allSat} callback.
   * @param  The result type of the callback, passed through by {@link #allSat}.
   */
  interface AllSatCallback {

    /**
     * Callback for each possible satisfying assignment to given
     * {@code important} predicates.
     * If the predicate is assigned {@code true} in the model, it is returned
     * as-is in the list,
     * and otherwise it is negated.
     * todo: this interface would not work properly for negated predicates.
     */
    void apply(List model);

    /**
     * Returning the result generated after all the {@link #apply} calls have
     * went through.
     */
    T getResult() throws InterruptedException;
  }
}