blob: bd4a782846d58fc1e4931ff74728d8b08dc65f7f [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Float object interface */
3
4/*
Guido van Rossumcaa63801995-01-12 11:45:45 +00005PyFloatObject represents a (double precision) floating point number.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006*/
7
Fred Drakeea9cb5a2000-07-09 00:20:36 +00008#ifndef Py_FLOATOBJECT_H
9#define Py_FLOATOBJECT_H
10#ifdef __cplusplus
11extern "C" {
12#endif
13
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000014typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000015 PyObject_HEAD
16 double ob_fval;
Guido van Rossumcaa63801995-01-12 11:45:45 +000017} PyFloatObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000018
Guido van Rossum051ab121995-02-27 10:17:52 +000019extern DL_IMPORT(PyTypeObject) PyFloat_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000021#define PyFloat_Check(op) PyObject_TypeCheck(op, &PyFloat_Type)
Tim Peters7a50f252001-09-10 21:28:20 +000022#define PyFloat_CheckExact(op) ((op)->ob_type == &PyFloat_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000023
Tim Peters72f98e92001-05-08 15:19:57 +000024/* 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). */
27extern DL_IMPORT(PyObject *) PyFloat_FromString(PyObject*, char** junk);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000028
Tim Peters72f98e92001-05-08 15:19:57 +000029/* Return Python float from C double. */
30extern DL_IMPORT(PyObject *) PyFloat_FromDouble(double);
31
32/* Extract C double from Python float. The macro version trades safety for
33 speed. */
34extern DL_IMPORT(double) PyFloat_AsDouble(PyObject *);
Guido van Rossum2981bc71997-08-02 02:40:58 +000035#define PyFloat_AS_DOUBLE(op) (((PyFloatObject *)(op))->ob_fval)
Guido van Rossuma3309961993-07-28 09:05:47 +000036
Tim Peters72f98e92001-05-08 15:19:57 +000037/* 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. */
41extern DL_IMPORT(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. */
48extern DL_IMPORT(void) PyFloat_AsString(char*, PyFloatObject *v);
49
Guido van Rossuma3309961993-07-28 09:05:47 +000050#ifdef __cplusplus
51}
52#endif
53#endif /* !Py_FLOATOBJECT_H */