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

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


#line 9 "dk4maai.ctr"

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

/**	Absolute value.
	@param	a	Operand.
	@param	erp	Error report, may be NULL.
	@return	Result on success, INT_MAX if a is INT_MIN
	(overflow is reported in erp).
	
	Error codes: DK4_E_OVERFLOW.
*/
int
dk4ma_int_abs(int a, dk4_er_t *erp);

/**	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.
*/
int
dk4ma_int_add(int a, int 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.
*/
int
dk4ma_int_sub(int a, int 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.
*/
int
dk4ma_int_mul(int a, int 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,
	INT_MIN, INT_MAX, or 0 on division by zero or overflow
	(see the ec component of erp).
	
	Error codes: DK4_E_OVERFLOW, DK4_E_DIVZERO.
*/
int
dk4ma_int_div(int a, int b, dk4_er_t *erp);

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

	Error codes: DK4_E_OVERFLOW.
*/
int
dk4ma_int_from(dk4_im_t i, dk4_er_t *erp);

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

	Error codes: DK4_E_OVERFLOW.
*/
int
dk4ma_int_from_double(double d, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif