document wxConvertFromIeeeExtended and wxConvertToIeeeExtended
[wxWidgets.git] / interface / wx / math.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: math.h
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /** @addtogroup group_funcmacro_math */
10 //@{
11
12 /**
13 Returns a non-zero value if @a x is neither infinite nor NaN (not a
14 number), returns 0 otherwise.
15
16 @header{wx/math.h}
17 */
18 int wxFinite(double x);
19
20 /**
21 Returns a non-zero value if x is NaN (not a number), returns 0 otherwise.
22
23 @header{wx/math.h}
24 */
25 bool wxIsNaN(double x);
26
27 /**
28 Converts the given array of 10 bytes (corresponding to 80 bits) to
29 a float number according to the IEEE floating point standard format
30 (aka IEEE standard 754).
31
32 @see wxConvertToIeeeExtended() to perform the opposite operation
33 */
34 wxFloat64 wxConvertFromIeeeExtended(const wxInt8 *bytes);
35
36 /**
37 Converts the given floating number @a num in a sequence of 10 bytes
38 which are stored in the given array @a bytes (which must be large enough)
39 according to the IEEE floating point standard format
40 (aka IEEE standard 754).
41
42 @see wxConvertFromIeeeExtended() to perform the opposite operation
43 */
44 void wxConvertToIeeeExtended(wxFloat64 num, wxInt8 *bytes);
45
46 //@}
47