using System;

namespace Python.Runtime
{
    /// 
    /// Represents a Python float object. See the documentation at
    /// PY2: https://docs.python.org/2/c-api/float.html
    /// PY3: https://docs.python.org/3/c-api/float.html
    /// for details.
    /// 
    public class PyFloat : PyNumber
    {
        /// 
        /// PyFloat Constructor
        /// 
        /// 
        /// Creates a new PyFloat from an existing object reference. Note
        /// that the instance assumes ownership of the object reference.
        /// The object reference is not checked for type-correctness.
        /// 
        public PyFloat(IntPtr ptr) : base(ptr)
        {
        }


        /// 
        /// PyFloat Constructor
        /// 
        /// 
        /// Copy constructor - obtain a PyFloat from a generic PyObject. An
        /// ArgumentException will be thrown if the given object is not a
        /// Python float object.
        /// 
        public PyFloat(PyObject o)
        {
            if (!IsFloatType(o))
            {
                throw new ArgumentException("object is not a float");
            }
            Runtime.XIncref(o.obj);
            obj = o.obj;
        }


        /// 
        /// PyFloat Constructor
        /// 
        /// 
        /// Creates a new Python float from a double value.
        /// 
        public PyFloat(double value)
        {
            obj = Runtime.PyFloat_FromDouble(value);
            Runtime.CheckExceptionOccurred();
        }


        /// 
        /// PyFloat Constructor
        /// 
        /// 
        /// Creates a new Python float from a string value.
        /// 
        public PyFloat(string value)
        {
            using (var s = new PyString(value))
            {
                obj = Runtime.PyFloat_FromString(s.obj, IntPtr.Zero);
                Runtime.CheckExceptionOccurred();
            }
        }


        /// 
        /// IsFloatType Method
        /// 
        /// 
        /// Returns true if the given object is a Python float.
        /// 
        public static bool IsFloatType(PyObject value)
        {
            return Runtime.PyFloat_Check(value.obj);
        }


        /// 
        /// AsFloat Method
        /// 
        /// 
        /// Convert a Python object to a Python float if possible, raising
        /// a PythonException if the conversion is not possible. This is
        /// equivalent to the Python expression "float(object)".
        /// 
        public static PyFloat AsFloat(PyObject value)
        {
            IntPtr op = Runtime.PyNumber_Float(value.obj);
            Runtime.CheckExceptionOccurred();
            return new PyFloat(op);
        }
    }
}