z3/src/api/java/AlgebraicNum.java

/**
Copyright (c) 2012-2014 Microsoft Corporation
   
Module Name:

    AlgebraicNum.java

Abstract:

Author:

    @author Christoph Wintersteiger (cwinter) 2012-03-15

Notes:
    
**/

package com.microsoft.z3;

/**
 * Algebraic numbers
 **/
public class AlgebraicNum extends ArithExpr
{
    /**
     * Return a upper bound for a given real algebraic number. The interval
     * isolating the number is smaller than 1/10^{@code precision}.
     * 
     * @see Expr#isAlgebraicNumber
     * @param precision the precision of the result
     * 
     * @return A numeral Expr of sort Real
     * @throws Z3Exception on error
     **/
    public RatNum toUpper(int precision)
    {

        return new RatNum(getContext(), Native.getAlgebraicNumberUpper(getContext()
                .nCtx(), getNativeObject(), precision));
    }

    /**
     * Return a lower bound for the given real algebraic number. The interval
     * isolating the number is smaller than 1/10^{@code precision}.
     * 
     * @see Expr#isAlgebraicNumber
     * @param precision precision
     * 
     * @return A numeral Expr of sort Real
     * @throws Z3Exception on error
     **/
    public RatNum toLower(int precision)
    {

        return new RatNum(getContext(), Native.getAlgebraicNumberLower(getContext()
                .nCtx(), getNativeObject(), precision));
    }

    /**
     * Returns a string representation in decimal notation.
     * Remarks: The result has at most {@code precision} decimal places.
     * @param precision precision
     * @return String
     * @throws Z3Exception on error
     **/
    public String toDecimal(int precision)
    {

        return Native.getNumeralDecimalString(getContext().nCtx(), getNativeObject(),
                precision);
    }

    AlgebraicNum(Context ctx, long obj)
    {
        super(ctx, obj);

    }
}