summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fpe.h
blob: 17c45001de277ef7941e58210e4a5e690d78c269 (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
/*
Copyright (C) 2016-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: dk4fpe.ctr
*/

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


#line 9 "dk4fpe.ctr"

/**	@file	dk4fpe.h	Floating point exceptions.
Note: When using functions from this module you should use
the compiler pragma to grant access to the floating
point environment.
This disables optimization of floating point operations.
The availability and the exact form of the pragma depends
on your compiler.

* pragma STDC FENV_ACCESS ON
  SUN workshop compiler.
  Probably other Unix/Linux compilers.
* pragma fenv_access (on)
  Visual Studio on Windows.

In version 4.13.1 and above the pragma is no longer included in
this header file as you probably want to apply it to some
code sections of a file only.
*/



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

#ifndef	DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.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

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

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



#if _WIN32 && defined(_MSC_VER)
/**	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);


#ifdef	__cplusplus
}
#endif



#endif