modmath.c 9.67 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

27
#include "py/builtin.h"
28

29
#if MICROPY_PY_BUILTINS_FLOAT && MICROPY_PY_MATH
30

31
32
#include <math.h>

33
34
35
36
37
/// \module math - mathematical functions
///
/// The `math` module provides some basic mathematical funtions for
/// working with floating-point numbers.

38
//TODO: Change macros to check for overflow and raise OverflowError or RangeError
39
#define MATH_FUN_1(py_name, c_name) \
40
    STATIC mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj) { return mp_obj_new_float(MICROPY_FLOAT_C_FUN(c_name)(mp_obj_get_float(x_obj))); } \
41
42
43
    STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);

#define MATH_FUN_2(py_name, c_name) \
44
    STATIC mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj, mp_obj_t y_obj) { return mp_obj_new_float(MICROPY_FLOAT_C_FUN(c_name)(mp_obj_get_float(x_obj), mp_obj_get_float(y_obj))); } \
45
46
    STATIC MP_DEFINE_CONST_FUN_OBJ_2(mp_math_## py_name ## _obj, mp_math_ ## py_name);

47
#define MATH_FUN_1_TO_BOOL(py_name, c_name) \
48
    STATIC mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj) { return mp_obj_new_bool(c_name(mp_obj_get_float(x_obj))); } \
49
50
    STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);

51
#define MATH_FUN_1_TO_INT(py_name, c_name) \
52
    STATIC mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj) { mp_int_t x = MICROPY_FLOAT_C_FUN(c_name)(mp_obj_get_float(x_obj)); return mp_obj_new_int(x); } \
53
54
    STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);

55
56
57
58
59
#if MP_NEED_LOG2
// 1.442695040888963407354163704 is 1/_M_LN2
#define log2(x) (log(x) * 1.442695040888963407354163704)
#endif

60
61
/// \function sqrt(x)
/// Returns the square root of `x`.
62
MATH_FUN_1(sqrt, sqrt)
63
64
/// \function pow(x, y)
/// Returns `x` to the power of `y`.
65
MATH_FUN_2(pow, pow)
66
/// \function exp(x)
67
MATH_FUN_1(exp, exp)
68
/// \function expm1(x)
Damien George's avatar
Damien George committed
69
MATH_FUN_1(expm1, expm1)
70
/// \function log2(x)
71
MATH_FUN_1(log2, log2)
72
/// \function log10(x)
73
MATH_FUN_1(log10, log10)
74
/// \function cosh(x)
75
MATH_FUN_1(cosh, cosh)
76
/// \function sinh(x)
77
MATH_FUN_1(sinh, sinh)
78
/// \function tanh(x)
79
MATH_FUN_1(tanh, tanh)
80
/// \function acosh(x)
81
MATH_FUN_1(acosh, acosh)
82
/// \function asinh(x)
83
MATH_FUN_1(asinh, asinh)
84
/// \function atanh(x)
85
MATH_FUN_1(atanh, atanh)
86
/// \function cos(x)
87
MATH_FUN_1(cos, cos)
88
/// \function sin(x)
89
MATH_FUN_1(sin, sin)
90
/// \function tan(x)
91
MATH_FUN_1(tan, tan)
92
/// \function acos(x)
93
MATH_FUN_1(acos, acos)
94
/// \function asin(x)
95
MATH_FUN_1(asin, asin)
96
/// \function atan(x)
97
MATH_FUN_1(atan, atan)
98
/// \function atan2(y, x)
99
MATH_FUN_2(atan2, atan2)
100
/// \function ceil(x)
101
MATH_FUN_1_TO_INT(ceil, ceil)
102
/// \function copysign(x, y)
103
MATH_FUN_2(copysign, copysign)
104
/// \function fabs(x)
105
MATH_FUN_1(fabs, fabs)
106
/// \function floor(x)
107
MATH_FUN_1_TO_INT(floor, floor) //TODO: delegate to x.__floor__() if x is not a float
108
/// \function fmod(x, y)
109
MATH_FUN_2(fmod, fmod)
110
/// \function isfinite(x)
111
MATH_FUN_1_TO_BOOL(isfinite, isfinite)
112
/// \function isinf(x)
113
MATH_FUN_1_TO_BOOL(isinf, isinf)
114
/// \function isnan(x)
115
MATH_FUN_1_TO_BOOL(isnan, isnan)
116
/// \function trunc(x)
117
MATH_FUN_1_TO_INT(trunc, trunc)
118
/// \function ldexp(x, exp)
119
MATH_FUN_2(ldexp, ldexp)
120
#if MICROPY_PY_MATH_SPECIAL_FUNCTIONS
121
122
/// \function erf(x)
/// Return the error function of `x`.
123
MATH_FUN_1(erf, erf)
124
125
/// \function erfc(x)
/// Return the complementary error function of `x`.
126
MATH_FUN_1(erfc, erfc)
127
128
/// \function gamma(x)
/// Return the gamma function of `x`.
129
MATH_FUN_1(gamma, tgamma)
130
131
/// \function lgamma(x)
/// return the natural logarithm of the gamma function of `x`.
132
MATH_FUN_1(lgamma, lgamma)
133
#endif
134
135
//TODO: factorial, fsum

136
137
138
139
140
141
142
143
144
145
146
147
148
// Function that takes a variable number of arguments

// log(x[, base])
STATIC mp_obj_t mp_math_log(mp_uint_t n_args, const mp_obj_t *args) {
    mp_float_t l = MICROPY_FLOAT_C_FUN(log)(mp_obj_get_float(args[0]));
    if (n_args == 1) {
        return mp_obj_new_float(l);
    } else {
        return mp_obj_new_float(l / MICROPY_FLOAT_C_FUN(log)(mp_obj_get_float(args[1])));
    }
}
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_math_log_obj, 1, 2, mp_math_log);

149
// Functions that return a tuple
150
151
152

/// \function frexp(x)
/// Converts a floating-point number to fractional and integral components.
153
STATIC mp_obj_t mp_math_frexp(mp_obj_t x_obj) {
154
155
156
157
158
159
    int int_exponent = 0;
    mp_float_t significand = MICROPY_FLOAT_C_FUN(frexp)(mp_obj_get_float(x_obj), &int_exponent);
    mp_obj_t tuple[2];
    tuple[0] = mp_obj_new_float(significand);
    tuple[1] = mp_obj_new_int(int_exponent);
    return mp_obj_new_tuple(2, tuple);
160
161
162
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_frexp_obj, mp_math_frexp);

163
/// \function modf(x)
164
STATIC mp_obj_t mp_math_modf(mp_obj_t x_obj) {
165
166
167
168
169
170
    mp_float_t int_part = 0.0;
    mp_float_t fractional_part = MICROPY_FLOAT_C_FUN(modf)(mp_obj_get_float(x_obj), &int_part);
    mp_obj_t tuple[2];
    tuple[0] = mp_obj_new_float(fractional_part);
    tuple[1] = mp_obj_new_float(int_part);
    return mp_obj_new_tuple(2, tuple);
171
172
173
174
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_modf_obj, mp_math_modf);

// Angular conversions
175
176

/// \function radians(x)
177
STATIC mp_obj_t mp_math_radians(mp_obj_t x_obj) {
178
    return mp_obj_new_float(mp_obj_get_float(x_obj) * M_PI / 180.0);
179
180
181
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_radians_obj, mp_math_radians);

182
/// \function degrees(x)
183
STATIC mp_obj_t mp_math_degrees(mp_obj_t x_obj) {
184
    return mp_obj_new_float(mp_obj_get_float(x_obj) * 180.0 / M_PI);
185
186
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_degrees_obj, mp_math_degrees);
187

188
189
STATIC const mp_map_elem_t mp_module_math_globals_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_math) },
190
191
    { MP_OBJ_NEW_QSTR(MP_QSTR_e), mp_const_float_e },
    { MP_OBJ_NEW_QSTR(MP_QSTR_pi), mp_const_float_pi },
192
193
194
    { MP_OBJ_NEW_QSTR(MP_QSTR_sqrt), (mp_obj_t)&mp_math_sqrt_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_pow), (mp_obj_t)&mp_math_pow_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_exp), (mp_obj_t)&mp_math_exp_obj },
Damien George's avatar
Damien George committed
195
    { MP_OBJ_NEW_QSTR(MP_QSTR_expm1), (mp_obj_t)&mp_math_expm1_obj },
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
    { MP_OBJ_NEW_QSTR(MP_QSTR_log), (mp_obj_t)&mp_math_log_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_log2), (mp_obj_t)&mp_math_log2_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_log10), (mp_obj_t)&mp_math_log10_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_cosh), (mp_obj_t)&mp_math_cosh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_sinh), (mp_obj_t)&mp_math_sinh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_tanh), (mp_obj_t)&mp_math_tanh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_acosh), (mp_obj_t)&mp_math_acosh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_asinh), (mp_obj_t)&mp_math_asinh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_atanh), (mp_obj_t)&mp_math_atanh_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_cos), (mp_obj_t)&mp_math_cos_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_sin), (mp_obj_t)&mp_math_sin_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_tan), (mp_obj_t)&mp_math_tan_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_acos), (mp_obj_t)&mp_math_acos_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_asin), (mp_obj_t)&mp_math_asin_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_atan), (mp_obj_t)&mp_math_atan_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_atan2), (mp_obj_t)&mp_math_atan2_obj },
212
213
214
215
    { MP_OBJ_NEW_QSTR(MP_QSTR_ceil), (mp_obj_t)&mp_math_ceil_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_copysign), (mp_obj_t)&mp_math_copysign_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_fabs), (mp_obj_t)&mp_math_fabs_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_floor), (mp_obj_t)&mp_math_floor_obj },
216
    { MP_OBJ_NEW_QSTR(MP_QSTR_fmod), (mp_obj_t)&mp_math_fmod_obj },
217
218
219
220
221
222
    { MP_OBJ_NEW_QSTR(MP_QSTR_frexp), (mp_obj_t)&mp_math_frexp_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_ldexp), (mp_obj_t)&mp_math_ldexp_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_modf), (mp_obj_t)&mp_math_modf_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_isfinite), (mp_obj_t)&mp_math_isfinite_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_isinf), (mp_obj_t)&mp_math_isinf_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_isnan), (mp_obj_t)&mp_math_isnan_obj },
223
    { MP_OBJ_NEW_QSTR(MP_QSTR_trunc), (mp_obj_t)&mp_math_trunc_obj },
224
225
    { MP_OBJ_NEW_QSTR(MP_QSTR_radians), (mp_obj_t)&mp_math_radians_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_degrees), (mp_obj_t)&mp_math_degrees_obj },
226
    #if MICROPY_PY_MATH_SPECIAL_FUNCTIONS
227
228
229
230
    { MP_OBJ_NEW_QSTR(MP_QSTR_erf), (mp_obj_t)&mp_math_erf_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_erfc), (mp_obj_t)&mp_math_erfc_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_gamma), (mp_obj_t)&mp_math_gamma_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_lgamma), (mp_obj_t)&mp_math_lgamma_obj },
231
    #endif
232
233
};

234
STATIC MP_DEFINE_CONST_DICT(mp_module_math_globals, mp_module_math_globals_table);
235
236
237
238

const mp_obj_module_t mp_module_math = {
    .base = { &mp_type_module },
    .name = MP_QSTR_math,
239
    .globals = (mp_obj_dict_t*)&mp_module_math_globals,
240
241
};

242
#endif // MICROPY_PY_BUILTINS_FLOAT && MICROPY_PY_MATH