Optimize.cs

Go to the documentation of this file.

/*++
Copyright (c) 2012 Microsoft Corporation
 
Module Name:
 
    Optimize.cs
 
Abstract:
 
    Z3 Managed API: Optimizes
 
Author:
 
    Nikolaj Bjorner (nbjorner) 2013-12-03
 
Notes:
    
--*/
 
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
 
namespace Microsoft.Z3
{
    public class Optimize : Z3Object
    {
        public string Help
        {
            get
            {
                return Native.Z3_optimize_get_help(Context.nCtx, NativeObject);
            }
        }
 
        public Params Parameters
        {
            set
            {
                Debug.Assert(value != null);
                Context.CheckContextMatch(value);
                Native.Z3_optimize_set_params(Context.nCtx, NativeObject, value.NativeObject);
            }
        }
 
        public void Set(string name, bool value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(string name, uint value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(string name, double value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(string name, string value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(string name, Symbol value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(Symbol name, bool value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(Symbol name, uint value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(Symbol name, double value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(Symbol name, string value) { Parameters = Context.MkParams().Add(name, value); }
        public void Set(Symbol name, Symbol value) { Parameters = Context.MkParams().Add(name, value); }
 
        public ParamDescrs ParameterDescriptions
        {
            get { return new ParamDescrs(Context, Native.Z3_optimize_get_param_descrs(Context.nCtx, NativeObject)); }
        }
 
        public void Assert(params BoolExpr[] constraints)
        {
            AddConstraints(constraints);
        }
 
        public void Assert(IEnumerable<BoolExpr> constraints)
        {
            AddConstraints(constraints);
        }
 
        public void Add(params BoolExpr[] constraints)
        {
            AddConstraints(constraints);
        }
 
        public void Add(IEnumerable<BoolExpr> constraints)
        {
            AddConstraints(constraints);
        }
 
        private void AddConstraints(IEnumerable<BoolExpr> constraints)
        {
            Debug.Assert(constraints != null);
            Debug.Assert(constraints.All(c => c != null));
 
            Context.CheckContextMatch(constraints);
            foreach (BoolExpr a in constraints)
            {
                Native.Z3_optimize_assert(Context.nCtx, NativeObject, a.NativeObject);
            }
        }
 
        public void AssertAndTrack(BoolExpr constraint, BoolExpr p)
        {
            Debug.Assert(constraint != null);
            Debug.Assert(p != null);
            Context.CheckContextMatch(constraint);
            Context.CheckContextMatch(p);
                        
            Native.Z3_optimize_assert_and_track(Context.nCtx, NativeObject, constraint.NativeObject, p.NativeObject);
        }
 
        public class Handle
        {
            Optimize opt;
            uint handle;
            internal Handle(Optimize opt, uint h)
            {
                this.opt = opt;
                this.handle = h;
            }
 
            public Expr Lower
            {
                get { return opt.GetLower(handle); }
            }
 
            public Expr Upper
            {
                get { return opt.GetUpper(handle); }
            }
 
            public Expr Value
            {
                get { return Lower; }
            }
 
            public Expr[] LowerAsVector
            {
                get { return opt.GetLowerAsVector(handle); }
            }
 
            public Expr[] UpperAsVector
            {
                get { return opt.GetUpperAsVector(handle); }
            }
 
        }
 
        public Handle AssertSoft(BoolExpr constraint, uint weight, string group)
        {
            Context.CheckContextMatch(constraint);
            using Symbol s = Context.MkSymbol(group);
            return new Handle(this, Native.Z3_optimize_assert_soft(Context.nCtx, NativeObject, constraint.NativeObject, weight.ToString(), s.NativeObject));
        }
 
 
        public Status Check(params Expr[] assumptions)
        {
            Z3_lbool r = (Z3_lbool)Native.Z3_optimize_check(Context.nCtx, NativeObject, (uint)assumptions.Length, AST.ArrayToNative(assumptions));
            switch (r)
            {
                case Z3_lbool.Z3_L_TRUE:
                    return Status.SATISFIABLE;
                case Z3_lbool.Z3_L_FALSE:
                    return Status.UNSATISFIABLE;
                default:
                    return Status.UNKNOWN;
            }
        }
 
        public void Push()
        {
            Native.Z3_optimize_push(Context.nCtx, NativeObject);
        }
 
        public void Pop()
        {
            Native.Z3_optimize_pop(Context.nCtx, NativeObject);
        }
 
 
        public Model Model
        {
            get
            {
                IntPtr x = Native.Z3_optimize_get_model(Context.nCtx, NativeObject);
                if (x == IntPtr.Zero)
                    return null;
                else
                    return new Model(Context, x);
            }
        }
 
        public BoolExpr[] UnsatCore
        {
            get
            {
 
                using ASTVector core = new ASTVector(Context, Native.Z3_optimize_get_unsat_core(Context.nCtx, NativeObject));                
                return core.ToBoolExprArray();
            }
        }
 
        public Handle MkMaximize(Expr e)
        {
            return new Handle(this, Native.Z3_optimize_maximize(Context.nCtx, NativeObject, e.NativeObject));
        }
 
        public Handle MkMinimize(Expr e)
        {
            return new Handle(this, Native.Z3_optimize_minimize(Context.nCtx, NativeObject, e.NativeObject));
        }
 
 
        private Expr GetLower(uint index)
        {
            return Expr.Create(Context, Native.Z3_optimize_get_lower(Context.nCtx, NativeObject, index));
        }
 
 
        private Expr GetUpper(uint index)
        {
            return Expr.Create(Context, Native.Z3_optimize_get_upper(Context.nCtx, NativeObject, index));
        }
 
        private Expr[] GetLowerAsVector(uint index)
        {
            using ASTVector v = new ASTVector(Context, Native.Z3_optimize_get_lower_as_vector(Context.nCtx, NativeObject, index));
            return v.ToExprArray();
        }
 
 
        private Expr[] GetUpperAsVector(uint index)
        {
            using ASTVector v = new ASTVector(Context, Native.Z3_optimize_get_upper_as_vector(Context.nCtx, NativeObject, index));
            return v.ToExprArray();
        }
 
        public String ReasonUnknown
        {
            get 
            {
                return Native.Z3_optimize_get_reason_unknown(Context.nCtx, NativeObject);
            }
        }
 
 
        public override string ToString()
        {
            return Native.Z3_optimize_to_string(Context.nCtx, NativeObject);
        }
 
        public void FromFile(string file)
        {
            Native.Z3_optimize_from_file(Context.nCtx, NativeObject, file);
        }
 
        public void FromString(string s)
        {
            Native.Z3_optimize_from_string(Context.nCtx, NativeObject, s);
        }
 
        public BoolExpr[] Assertions
        {
            get
            {
 
                using ASTVector assertions = new ASTVector(Context, Native.Z3_optimize_get_assertions(Context.nCtx, NativeObject));
                return assertions.ToBoolExprArray();
            }
        }
 
        public Expr[] Objectives
        {
            get
            {
 
                using ASTVector objectives = new ASTVector(Context, Native.Z3_optimize_get_objectives(Context.nCtx, NativeObject));
                return objectives.ToExprArray();
            }
        }
 
 
        public Statistics Statistics
        {
            get
            {
 
                return new Statistics(Context, Native.Z3_optimize_get_statistics(Context.nCtx, NativeObject));
            }
        }
 
 
        #region Internal
        internal Optimize(Context ctx, IntPtr obj)
            : base(ctx, obj)
        {
            Debug.Assert(ctx != null);
        }
        internal Optimize(Context ctx)
            : base(ctx, Native.Z3_mk_optimize(ctx.nCtx))
        {
            Debug.Assert(ctx != null);
        }
 
        internal override void IncRef(IntPtr o)
        {
            Native.Z3_optimize_inc_ref(Context.nCtx, o);
        }
 
        internal override void DecRef(IntPtr o)
        {
            lock (Context)
            {
                if (Context.nCtx != IntPtr.Zero)
                    Native.Z3_optimize_dec_ref(Context.nCtx, o);
            }
        }
        #endregion
    }
}