summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fpe.h
blob: 553c6b2c7690d049da871fa2ae57d74f3b0a90b5 (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
/*
	WARNING: This file was generated by dkct.
	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: dk4fpe.ctr
*/

/*
Copyright (C) 2016-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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


#line 9 "dk4fpe.ctr"

/**	@file	dk4fpe.h	Floating point exceptions.

	Note: Including this file disables optimization of
	floating point operations by use of compiler pragma directives.

	Use only in those modules in which you want to check for
	floating point exceptions.

	This header file should be the last file included by a module.
*/



/*	Pragmas differ on Windows and Unix/Linux to prevent optimization
	of floating point operations.
	At least one compiler bails out with error message for unknown
	pragma directives.
*/

#ifndef	_WIN32
/* +++ !Windows */
#ifdef __SUNPRO_C
/* +++ !Windows, SUN workshop compiler */
#if __SUNPRO_C > 0x570
#pragma	STDC FENV_ACCESS on
#endif
/* --- !Windows, SUN workshop compiler */
#else
/* +++ !Windows, ! SUN workshop compiler */
#pragma	STDC FENV_ACCESS on
/* --- !Windows, ! SUN workshop compiler */
#endif
/* --- !Windows */
#endif


#ifndef	DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef	DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#if	DK4_HAVE_MATH_H
#ifndef	MATH_H_INCLUDED
#ifdef	_WIN32
#define	_USE_MATH_DEFINES	1
#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

#ifndef	_WIN32
#if	DK4_HAVE_FENV_H
#ifndef	FENV_H_INCLUDED
#include <fenv.h>
#define	FENV_H_INCLUDED	1
#endif
#endif
#endif

#ifndef	DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifdef	_WIN32
/* +++ Windows */
#pragma fenv_access (on)
/* --- Windows */
#endif

#ifdef	_WIN32
/**	Floating point exception set.
*/
typedef	unsigned int	dk4_fpe_t;
#else
/**	Floating point exception set.
*/
typedef	int		dk4_fpe_t;
#endif

#ifdef	__cplusplus
extern "C" {
#endif


/**	Check floating point exception set for errors occured.
	@param	fpe	Floating point exception set.
	@param	erp	Error report, may be NULL.
	@return	1 if error exceptions are set, 0 if there is no
	error condition.

	Error codes:
	* DK4_E_MATH_INVALID<br>
	  if an invalid operation was performed,
	* DK4_E_MATH_DIVZERO<br>
	  if a division by zero (or small denominator) occured,
	* DK4_E_MATH_OVERFLOW<br>
	  if a range overflow occured (result too large),
	* DK4_E_MATH_UNDERFLOW<br>
	  if a range underflow occured (result too small).
*/

int
dk4fpe_check_error(dk4_fpe_t fpe, dk4_er_t *erp);


/**	Clear floating point exceptions.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	* DK4_E_NOT_SUPPORTED<br>
	  if no functions for floating point exceptions are available,
	* DK4_E_SYSTEM<br>
	  if the feclearexcept() function indicated an error.
*/

int
dk4fpe_clear(dk4_er_t *erp);


/**	Obtain floating point exceptions.
	@param	dptr	Address of destination variable to store result.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	* DK4_E_INVALID_ARGUMENTS<br>
	  if dptr is NULL,
	* DK4_E_NOT_SUPPORTED<br>
	  if no functions for floating point exceptions are available.
*/

int
dk4fpe_get(dk4_fpe_t *dptr, dk4_er_t *erp);


/**	Obtain and clear floating point exceptions.
	@param	dptr	Address of destination variable to store result.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	* DK4_E_INVALID_ARGUMENTS<br>
	  if dptr is NULL,
	* DK4_E_NOT_SUPPORTED<br>
	  if no functions for floating point exceptions are available,
	* DK4_E_SYSTEM<br>
	  if the feclearexcept() function indicated an error.
*/

int
dk4fpe_get_clear(dk4_fpe_t *dptr, dk4_er_t *erp);


/**	Check a double value whether or not it is a finite number
	(not +/- INF, not NaN).
	@param	d	Value to check.
	@return	1 on success, 0 on error.
*/

int
dk4fpe_is_finite(double d) ;


/**	Check a double value whether or not it is a normalized number
	(not +/- INF, not NaN, not denormalized).
	@param	d	Value to check.
	@return	1 on success, 0 on error.
*/
int
dk4fpe_is_normal(double d);


#ifdef	__cplusplus
}
#endif



#endif