summaryrefslogtreecommitdiff
path: root/support/dktools/dk4maau16.h
blob: 8c7ea08149177728480bc3ebf584f88d6005db35 (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
/*
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: dk4maau16.ctr
*/

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


#line 9 "dk4maau16.ctr"

/**	@file	dk4maau16.h	Operations on uint16_t data.

	CRT on Windows: Optional.
*/


#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

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

#if DK4_HAVE_STDLIB_H
#ifndef	DK4_STDLIB_H_INCLUDED
#include <stdlib.h>
#define	DK4_STDLIB_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_SYS_TYPES_H
#ifndef	DK4_SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define	DK4_SYS_TYPES_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_STDINT_H
#ifndef	DK4_STDINT_H_INCLUDED
#include <stdint.h>
#define	DK4_STDINT_H_INCLUDED 1
#endif
#endif

#ifndef	UINT16_MAX
#define	UINT16_MAX	((uint16_t)65535U)
#endif

#ifdef	__cplusplus
extern "C" {
#endif

/**	Addition of uint16_t.
	@param	a	Left operand.
	@param	b	Right operand.
	@param	erp	Error report, may be NULL.
	@return	Operation result.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if a or b is out of range
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overfow occured.
*/
uint16_t
dk4ma_uint16_t_add(uint16_t a, uint16_t b, dk4_er_t *erp);

/**	Substraction of uint16_t.
	@param	a	Left operand.
	@param	b	Right operand.
	@param	erp	Error report, may be NULL.
	@return	Operation result.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if a or b is out of range
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overfow occured.
*/
uint16_t
dk4ma_uint16_t_sub(uint16_t a, uint16_t b, dk4_er_t *erp);

/**	Multiplication of uint16_t.
	@param	a	Left operand.
	@param	b	Right operand.
	@param	erp	Error report, may be NULL.
	@return	Operation result.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if a or b is out of range
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overfow occured.
*/
uint16_t
dk4ma_uint16_t_mul(uint16_t a, uint16_t b, dk4_er_t *erp);

/**	Division of uint16_t.
	@param	a	Left operand.
	@param	b	Right operand.
	@param	erp	Error report, may be NULL.
	@return	Operation result.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if a or b is out of range
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overfow occured,
	- DK4_E_MATH_DIVZERO<br>
	  if b is 0.
*/
uint16_t
dk4ma_uint16_t_div(uint16_t a, uint16_t b, dk4_er_t *erp);

/**	Convert dk4_um_t value to uint16_t.
	@param	u	Value to convert.
	@param	erp	Error report, may be NULL.
	@return	Conversion result.

	Error codes: DK4_E_MATH_OVERFLOW.
*/
uint16_t
dk4ma_uint16_from(dk4_um_t u, dk4_er_t *erp);

/**	Convert double to signed char.
	@param	d	Value to convert.
	@param	erp	Error report, may be NULL.
	@return	Conversion result.

	Error codes: DK4_E_OVERFLOW.
*/
uint16_t
dk4ma_uint16_from_double(double d, dk4_er_t *erp);

#ifdef	__cplusplus
}
#endif



#endif