source: trunk/essentials/dev-lang/python/Include/floatobject.h@ 3391

Last change on this file since 3391 was 3225, checked in by bird, 19 years ago

Python 2.5

File size: 4.1 KB
Line 
1
2/* Float object interface */
3
4/*
5PyFloatObject represents a (double precision) floating point number.
6*/
7
8#ifndef Py_FLOATOBJECT_H
9#define Py_FLOATOBJECT_H
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14typedef struct {
15 PyObject_HEAD
16 double ob_fval;
17} PyFloatObject;
18
19PyAPI_DATA(PyTypeObject) PyFloat_Type;
20
21#define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
22#define PyFloat_CheckExact(op) ((op)->ob_type == &PyFloat_Type)
23
24/* Return Python float from string PyObject. Second argument ignored on
25 input, and, if non-NULL, NULL is stored into *junk (this tried to serve a
26 purpose once but can't be made to work as intended). */
27PyAPI_FUNC(PyObject *) PyFloat_FromString(PyObject*, char** junk);
28
29/* Return Python float from C double. */
30PyAPI_FUNC(PyObject *) PyFloat_FromDouble(double);
31
32/* Extract C double from Python float. The macro version trades safety for
33 speed. */
34PyAPI_FUNC(double) PyFloat_AsDouble(PyObject *);
35#define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
36
37/* Write repr(v) into the char buffer argument, followed by null byte. The
38 buffer must be "big enough"; >= 100 is very safe.
39 PyFloat_AsReprString(buf, x) strives to print enough digits so that
40 PyFloat_FromString(buf) then reproduces x exactly. */
41PyAPI_FUNC(void) PyFloat_AsReprString(char*, PyFloatObject *v);
42
43/* Write str(v) into the char buffer argument, followed by null byte. The
44 buffer must be "big enough"; >= 100 is very safe. Note that it's
45 unusual to be able to get back the float you started with from
46 PyFloat_AsString's result -- use PyFloat_AsReprString() if you want to
47 preserve precision across conversions. */
48PyAPI_FUNC(void) PyFloat_AsString(char*, PyFloatObject *v);
49
50/* _PyFloat_{Pack,Unpack}{4,8}
51 *
52 * The struct and pickle (at least) modules need an efficient platform-
53 * independent way to store floating-point values as byte strings.
54 * The Pack routines produce a string from a C double, and the Unpack
55 * routines produce a C double from such a string. The suffix (4 or 8)
56 * specifies the number of bytes in the string.
57 *