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

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


#line 10 "dk4maadu.ctr"

/**	@file
	Arithmetic operations on dk4_um_t.
	
	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.
*/
dk4_um_t
dk4ma_um_add(dk4_um_t a, dk4_um_t 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.
*/
dk4_um_t
dk4ma_um_sub(dk4_um_t a, dk4_um_t 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.
*/
dk4_um_t
dk4ma_um_mul(dk4_um_t a, dk4_um_t 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,
        DK4_UM_MAX on division by zero
        (see the ec component of erp).
        
	Error codes: DK4_E_DIVZERO.
*/
dk4_um_t
dk4ma_um_div(dk4_um_t a, dk4_um_t b, dk4_er_t *erp);

/**	Calculate greatest common divisor of two numbers.
	@param	a	One number.
	@param	b	Other number.
	@return	Greatest common divisor.
*/
dk4_um_t
dk4ma_um_gcd(dk4_um_t a, dk4_um_t b);

/**	Calculate least common multiple of two numbers.
	@param	a	One number.
	@param	b	Other number.
	@param	erp	Error report, may be NULL.
	@return	Least common multiple of a and b.

	Error codes: DK4_E_OVERFLOW, DK4_E_DIVZERO.
*/
dk4_um_t
dk4ma_um_lcm(dk4_um_t a, dk4_um_t b, dk4_er_t *erp);

/**	Comparison: Is a greater than b.
	@param	a	Left comparison operand.
	@param	b	Right comparison operand.
	@return	1 if a>b, 0 otherwise.
*/
int
dk4ma_um_isgr(dk4_um_t a, dk4_um_t b);

/**	Comparison: Is a greater than or equal to b.
	@param	a	Left comparison operand.
	@param	b	Right comparison operand.
	@return	1 if a>=b, 0 otherwise.
*/
int
dk4ma_um_isgeq(dk4_um_t a, dk4_um_t b);

#ifdef __cplusplus
}
#endif



#endif