floatobject.h 1.74 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3 4
/* Float object interface */

/*
5
PyFloatObject represents a (double precision) floating point number.
Guido van Rossum's avatar
Guido van Rossum committed
6 7
*/

8 9 10 11 12 13
#ifndef Py_FLOATOBJECT_H
#define Py_FLOATOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

Guido van Rossum's avatar
Guido van Rossum committed
14
typedef struct {
15 16
    PyObject_HEAD
    double ob_fval;
17
} PyFloatObject;
Guido van Rossum's avatar
Guido van Rossum committed
18

19
PyAPI_DATA(PyTypeObject) PyFloat_Type;
Guido van Rossum's avatar
Guido van Rossum committed
20

21
#define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
22
#define PyFloat_CheckExact(op) ((op)->ob_type == &PyFloat_Type)
Guido van Rossum's avatar
Guido van Rossum committed
23

24 25 26
/* Return Python float from string PyObject.  Second argument ignored on
   input, and, if non-NULL, NULL is stored into *junk (this tried to serve a
   purpose once but can't be made to work as intended). */
27
PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*, char** junk);
28 29

/* Return Python float from C double. */
30
PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double);
Guido van Rossum's avatar
Guido van Rossum committed
31

32 33
/* Extract C double from Python float.  The macro version trades safety for
   speed. */
34
PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *);
35
#define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
36

37 38 39 40
/* Write repr(v) into the char buffer argument, followed by null byte.  The
   buffer must be "big enough"; >= 100 is very safe.
   PyFloat_AsReprString(buf, x) strives to print enough digits so that
   PyFloat_FromString(buf) then reproduces x exactly. */
41
PyAPI_FUNC(void) PyFloat_AsReprString(char*, PyFloatObject *v);
42 43 44 45 46 47

/* Write str(v) into the char buffer argument, followed by null byte.  The
   buffer must be "big enough"; >= 100 is very safe.  Note that it's
   unusual to be able to get back the float you started with from
   PyFloat_AsString's result -- use PyFloat_AsReprString() if you want to
   preserve precision across conversions. */
48
PyAPI_FUNC(void) PyFloat_AsString(char*, PyFloatObject *v);
49

50 51 52 53
#ifdef __cplusplus
}
#endif
#endif /* !Py_FLOATOBJECT_H */