summaryrefslogtreecommitdiff
path: root/support/dktools/dk4maaui.h
blob: 8448fe1384789a9ac4035022beef6ef8428fbe8f (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
/*
Copyright (C) 2015-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: dk4maaui.ctr
*/

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


#line 10 "dk4maaui.ctr"

/**	@file
	Arithmetic operations on unsigned int.
	
	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



#ifdef __cplusplus
extern "C" {
#endif

/**	Addition.
        @param	a	Left operand.
        @param	b	Right operand.
        @param	erp	Error report, may be NULL.
        @return	Result on success, least significant result bits
        on overflow (see ec component of erp).
        
	Error codes: DK4_E_OVERFLOW.
*/
unsigned
dk4ma_uint_add(unsigned a, unsigned b, dk4_er_t *erp);

/**	Subtraction.
        @param	a	Left operand.
        @param	b	Right operand.
        @param	erp	Error report, may be NULL.
        @return	Result on success, least significant result bits
        on overflow (see ec component of erp).
        
	Error codes: DK4_E_OVERFLOW.
*/
unsigned
dk4ma_uint_sub(unsigned a, unsigned b, dk4_er_t *erp);

/**	Multiplication.
        @param	a	Left factor.
        @param	b	right factor.
        @param	erp	Error report, may be NULL.
        @return	Result on success, least significant
        bits on overflow (see ec component of erp).
        
	Error codes: DK4_E_OVERFLOW.
*/
unsigned
dk4ma_uint_mul(unsigned a, unsigned b, dk4_er_t *erp);

/**	Division.
        @param	a	Counter (left operand).
        @param	b	Denominator (right operand).
        @param	erp	Error report, may be NULL.
        @return	Division result on success,
        UINT_MAX on division by zero
        (see the ec component of erp).
        
	Error codes: DK4_E_MATH_DIVZERO.
*/
unsigned
dk4ma_uint_div(unsigned a, unsigned b, dk4_er_t *erp);

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

	Error codes: DK4_E_MATH_OVERFLOW.
*/
unsigned
dk4ma_uint_from(dk4_um_t u, dk4_er_t *erp);


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

	Error codes: DK4_E_OVERFLOW.
*/
unsigned
dk4ma_uint_from_double(double d, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif