Remove all lines containing cvs/svn "$Id$" keyword.
[wxWidgets.git] / interface / wx / math.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: math.h
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
5 // Licence: wxWindows licence
6 /////////////////////////////////////////////////////////////////////////////
7
8 /** @addtogroup group_funcmacro_math */
9 //@{
10
11 /**
12 Returns a non-zero value if @a x is neither infinite nor NaN (not a
13 number), returns 0 otherwise.
14
15 @header{wx/math.h}
16 */
17 int wxFinite(double x);
18
19 /**
20 Returns a non-zero value if x is NaN (not a number), returns 0 otherwise.
21
22 @header{wx/math.h}
23 */
24 bool wxIsNaN(double x);
25
26 /**
27 Converts the given array of 10 bytes (corresponding to 80 bits) to
28 a float number according to the IEEE floating point standard format
29 (aka IEEE standard 754).
30
31 @see wxConvertToIeeeExtended() to perform the opposite operation
32 */
33 wxFloat64 wxConvertFromIeeeExtended(const wxInt8 *bytes);
34
35 /**
36 Converts the given floating number @a num in a sequence of 10 bytes
37 which are stored in the given array @a bytes (which must be large enough)
38 according to the IEEE floating point standard format
39 (aka IEEE standard 754).
40
41 @see wxConvertFromIeeeExtended() to perform the opposite operation
42 */
43 void wxConvertToIeeeExtended(wxFloat64 num, wxInt8 *bytes);
44
45 /**
46 Small wrapper around round().
47 */
48 int wxRound(double x);
49
50 /**
51 Returns true if both double values are identical. This is
52 only reliable if both values have been assigned the same
53 value.
54 */
55 bool wxIsSameDouble(double x, double y);
56
57 /**
58 Return true of @a x is exactly zero. This is only reliable
59 if it has been assigned 0.
60 */
61 bool wxIsNullDouble(double x);
62
63 //@}
64