wxWidgets/interface/wx/math.h
Vadim Zeitlin a380c1e46f Add public wxDegToRad() and wxRadToDeg() functions.
Define these functions just once in wx/math.h instead of duplicating them in a
dozen of places.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76555 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-05-17 12:29:15 +00:00

89 lines
2.1 KiB
C

/////////////////////////////////////////////////////////////////////////////
// Name: math.h
// Purpose: interface of global functions
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/** @addtogroup group_funcmacro_math */
//@{
/**
Returns a non-zero value if @a x is neither infinite nor NaN (not a
number), returns 0 otherwise.
@header{wx/math.h}
*/
int wxFinite(double x);
/**
Returns a non-zero value if x is NaN (not a number), returns 0 otherwise.
@header{wx/math.h}
*/
bool wxIsNaN(double x);
/**
Converts the given array of 10 bytes (corresponding to 80 bits) to
a float number according to the IEEE floating point standard format
(aka IEEE standard 754).
@see wxConvertToIeeeExtended() to perform the opposite operation
*/
wxFloat64 wxConvertFromIeeeExtended(const wxInt8 *bytes);
/**
Converts the given floating number @a num in a sequence of 10 bytes
which are stored in the given array @a bytes (which must be large enough)
according to the IEEE floating point standard format
(aka IEEE standard 754).
@see wxConvertFromIeeeExtended() to perform the opposite operation
*/
void wxConvertToIeeeExtended(wxFloat64 num, wxInt8 *bytes);
/**
Convert degrees to radians.
This function simply returns its argument multiplied by @c M_PI/180 but is
more readable than writing this expression directly.
@see wxRadToDeg()
@since 3.1.0
*/
double wxDegToRad(double deg);
/**
Convert radians to degrees.
This function simply returns its argument multiplied by @c 180/M_PI but is
more readable than writing this expression directly.
@see wxDegToRad()
@since 3.1.0
*/
double wxRadToDeg(double rad);
/**
Small wrapper around round().
*/
int wxRound(double x);
/**
Returns true if both double values are identical. This is
only reliable if both values have been assigned the same
value.
*/
bool wxIsSameDouble(double x, double y);
/**
Return true of @a x is exactly zero. This is only reliable
if it has been assigned 0.
*/
bool wxIsNullDouble(double x);
//@}