z3/src/api/java/Tactic.java

/**
 * This file was automatically generated from Tactic.cs 
 * w/ further modifications by:
 * @author Christoph M. Wintersteiger (cwinter)
 **/

package com.microsoft.z3;

/**
 * Tactics are the basic building block for creating custom solvers for specific
 * problem domains. The complete list of tactics may be obtained using
 * <code>Context.NumTactics</code> and <code>Context.TacticNames</code>. It may
 * also be obtained using the command <code>(help-tactics)</code> in the SMT 2.0
 * front-end.
 **/
public class Tactic extends Z3Object
{
    /**
     * A string containing a description of parameters accepted by the tactic.
     **/
    public String getHelp() throws Z3Exception
    {
        return Native.tacticGetHelp(getContext().nCtx(), getNativeObject());
    }

    /**
     * Retrieves parameter descriptions for Tactics.
     * @throws Z3Exception 
     **/
    public ParamDescrs getParameterDescriptions() throws Z3Exception
    {
        return new ParamDescrs(getContext(), Native.tacticGetParamDescrs(getContext()
                .nCtx(), getNativeObject()));
    }

    /**
     * Execute the tactic over the goal.
     * @throws Z3Exception 
     **/
    public ApplyResult apply(Goal g) throws Z3Exception
    {	
        return apply(g, null);
    }

    /**
     * Execute the tactic over the goal.
     * @throws Z3Exception 
     **/
    public ApplyResult apply(Goal g, Params p) throws Z3Exception
    {
        getContext().checkContextMatch(g);
        if (p == null)
            return new ApplyResult(getContext(), Native.tacticApply(getContext()
                    .nCtx(), getNativeObject(), g.getNativeObject()));
        else
        {
            getContext().checkContextMatch(p);
            return new ApplyResult(getContext(),
                    Native.tacticApplyEx(getContext().nCtx(), getNativeObject(),
                            g.getNativeObject(), p.getNativeObject()));
        }
    }

    /**
     * Creates a solver that is implemented using the given tactic. <seealso
     * cref="Context.MkSolver(Tactic)"/>
     * @throws Z3Exception 
     **/
    public Solver getSolver() throws Z3Exception
    {
        return getContext().mkSolver(this);
    }

    Tactic(Context ctx, long obj) throws Z3Exception
    {
        super(ctx, obj);
    }

    Tactic(Context ctx, String name) throws Z3Exception
    {
        super(ctx, Native.mkTactic(ctx.nCtx(), name));
    }

    void incRef(long o) throws Z3Exception
    {
        getContext().tactic_DRQ().incAndClear(getContext(), o);
        super.incRef(o);
    }

    void decRef(long o) throws Z3Exception
    {
        getContext().tactic_DRQ().add(o);
        super.decRef(o);
    }
}