summaryrefslogtreecommitdiff
path: root/support/dktools/dk4math.h
blob: 0c21e195f0441dd61cc41bae8745c0535ab3c4bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*
Copyright (C) 2017-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4math.ctr
*/

#ifndef DK4MATH_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4MATH_H_INCLUDED 1


#line 8 "dk4math.ctr"

/**	@file	dk4math.h	Functions and macros not available on all platforms.

If some of the functions or macros rint(), isgreater(), isgreaterequal(),
isless() and islessequal() - typically defined in math.h - are missing,
this header file defines either
macros or static inline functions calling the provided fallback
functions dk4ma_rint(), dk4ma_isgreater(), dk4ma_isgreaterequal(),
dk4ma_isless() or dk4ma_islessequal().

Inline functions are used if both DK4_HAVE_INLINE and DK4_USE_INLINE
are enabled, macros are used otherwise.

Although the CERT C coding standard prefers use of inline functions over macros,
I prefer macros as the static inline functions
(a) create slightly larger object modules,
(b) create warnings for those static inline functions not used in the module and
(c) might create warnings if the compiler decides to use real functions
instead of generating inline code.

The dk4ma_rint() function in the module is always compiled to avoid
``empty compilation unit'' warnings. The other functions in this module
are only compiled if necessary.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#if	DK4_HAVE_MATH_H
#ifndef	MATH_H_INCLUDED
#if	DK4_ON_WINDOWS
#ifndef	_USE_MATH_DEFINES
#define	_USE_MATH_DEFINES 1
#endif
#endif
#include <math.h>
#define	MATH_H_INCLUDED 1
#endif
#endif

#if	DK4_HAVE_FLOAT_H
#ifndef	FLOAT_H_INCLUDED
#include <float.h>
#define	FLOAT_H_INCLUDED 1
#endif
#endif

#ifdef	__cplusplus
extern "C" {
#endif

#if	(!(DK4_HAVE_RINT))
/**	Round value to next integer.
	@param	x	floating point valued.
	@return	Floating point value rounded to next integer.
*/
double
dk4ma_rint(double x);
#endif

#if	(!(DK4_HAVE_ISGREATER))
/**	Check whether a is greater than b.
	@param	a	Floating point value.
	@param	b	Floating point value.
	@return	Comparison result.
*/
int
dk4ma_isgreater(double a, double b);
#endif

#if	(!(DK4_HAVE_ISGREATEREQUAL))
/**	Check whether a is greater than or equal to b.
	@param	a	Floating point value.
	@param	b	Floating point value.
	@return	Comparison result.
*/
int
dk4ma_isgreaterequal(double a, double b);
#endif

#if (!(DK4_HAVE_ISLESS))
/**	Check whether a is less than b.
	@param	a	Floating point value.
	@param	b	Floating point value.
	@return	Comparison result.
*/
int
dk4ma_isless(double a, double b);
#endif

#if	(!(DK4_HAVE_ISLESSEQUAL))
/**	Check whether a is less than or equal to b.
	@param	a	Floating point value.
	@param	b	Floating point value.
	@return	Comparison result.
*/
int
dk4ma_islessequal(double a, double b);
#endif

/**	Check whether or not a double value is finite.
	@param	d	Value to check.
	@return	Nonzero for finite value, zero for infinite value or NaN.
*/
int
dk4ma_is_finite(double d);

/**	Check whether double value is in normalized representation.
	@param	d	Value to check.
	@return	Nonzero for normalized value, zero for non-normalized value.
*/
int
dk4ma_is_normal(double d);

#ifdef	__cplusplus
}
#endif




#if	(!(DK4_HAVE_RINT))
#if	DK4_HAVE_INLINE && DK4_USE_INLINE
static
inline
double
rint(double x)
{
	return (dk4ma_rint(x));
}
#else
/**	The rint() function rounds to next integer.
*/
#define	rint(x)	dk4ma_rint(x)
#endif
#endif


#if (!(DK4_HAVE_ISGREATER))
#if	DK4_HAVE_INLINE && DK4_USE_INLINE
/**	Compare two double values, check if left value is greater than right value.
	@param	a	Left value.
	@param	b	Right value.
	@return	Comparison result.
*/
static
inline
int
isgreater(double a, double b)
{
	return (dk4ma_isgreater(a,b));
}
#else
/**	Compare to values.
*/
#define	isgreater(a,b)	dk4ma_isgreater(a,b)
#endif
#endif


#if (!(DK4_HAVE_ISGREATEREQUAL))
#if	DK4_HAVE_INLINE && DK4_USE_INLINE
/**	Compare two double values, check if left value is greater than
	or equal to right value.
	@param	a	Left value.
	@param	b	Right value.
	@return	Comparison result.
*/
static
inline
int
isgreaterequal(double a, double b)
{
	return (dk4ma_isgreaterequal(a,b));
}
#else
/**	Compare to values.
*/
#define	isgreaterequal(a,b)	dk4ma_isgreaterequal(a,b)
#endif
#endif


#if (!(DK4_HAVE_ISLESS))
#if	DK4_HAVE_INLINE && DK4_USE_INLINE
/**	Compare two double values, check if left value is less than right value.
	@param	a	Left value.
	@param	b	Right value.
	@return	Comparison result.
*/
static
inline
int
isless(double a, double b)
{
	return (dk4ma_isless(a,b));
}
#else
/**	Compare to values.
*/
#define	isless(a,b)	dk4ma_isless(a,b)
#endif
#endif


#if (!(DK4_HAVE_ISLESSEQUAL))
#if	DK4_HAVE_INLINE && DK4_USE_INLINE
/**	Compare two double values, check if left value is less than
	or equal to right value.
	@param	a	Left value.
	@param	b	Right value.
	@return	Comparison result.
*/
static
inline
int
islessequal(double a, double b)
{
	return (dk4ma_islessequal(a,b));
}
#else
/**	Compare to values.
*/
#define	islessequal(a,b)	dk4ma_islessequal(a,b)
#endif
#endif




#endif