hu.bme.mit.theta.solver.SolverBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of theta-solver Show documentation

Solver subproject in the Theta model checking framework

There is a newer version: 6.8.5

/*
 *  Copyright 2024 Budapest University of Technology and Economics
 *
 *  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 hu.bme.mit.theta.solver;

import hu.bme.mit.theta.core.model.Valuation;
import hu.bme.mit.theta.core.type.Expr;
import hu.bme.mit.theta.core.type.booltype.BoolType;

import java.util.Collection;

public interface SolverBase extends AutoCloseable {


    /**
     * Check if the currently added expressions are satisfiable.
     *
     * @return Status
     */
    SolverStatus check();

    /**
     * Push the current solver state. When calling {@link #pop()}, all expressions added after the
     * last push will be removed.
     */
    void push();

    /**
     * Remove expressions added after the previous n {@link #push()} calls.
     *
     * @param n
     */
    void pop(final int n);

    /**
     * Remove expressions added after the previous {@link #push()} call.
     */
    default void pop() {
        pop(1);
    }

    /**
     * Reset the solver state.
     */
    void reset();

    /**
     * Get the current status of the solver.
     *
     * @return Status
     */
    SolverStatus getStatus();

    /**
     * Get the satisfying assignment for the currently added expressions. Should only be called if
     * {@link #check()} was already called and the result is SAT.
     *
     * @return Satisfying assignment
     */
    Valuation getModel();

    /**
     * Get the currently added expressions.
     *
     * @return Expressions
     */
    Collection> getAssertions();
}