2014-05-03 22:27:38 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2014-03-08 15:24:39 +00:00
|
|
|
#include <math.h>
|
|
|
|
|
|
|
|
#include "mpconfig.h"
|
2014-06-21 19:43:22 +00:00
|
|
|
#include "misc.h"
|
2014-03-08 15:24:39 +00:00
|
|
|
#include "qstr.h"
|
|
|
|
#include "obj.h"
|
|
|
|
#include "builtin.h"
|
|
|
|
|
2014-06-01 12:32:54 +00:00
|
|
|
#if MICROPY_PY_BUILTINS_FLOAT && MICROPY_PY_MATH
|
2014-03-08 15:24:39 +00:00
|
|
|
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \module math - mathematical functions
|
|
|
|
///
|
|
|
|
/// The `math` module provides some basic mathematical funtions for
|
|
|
|
/// working with floating-point numbers.
|
|
|
|
|
2014-03-22 14:39:33 +00:00
|
|
|
//TODO: Change macros to check for overflow and raise OverflowError or RangeError
|
2014-03-08 15:24:39 +00:00
|
|
|
#define MATH_FUN_1(py_name, c_name) \
|
|
|
|
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))); } \
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);
|
|
|
|
|
|
|
|
#define MATH_FUN_2(py_name, c_name) \
|
|
|
|
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))); } \
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mp_math_## py_name ## _obj, mp_math_ ## py_name);
|
|
|
|
|
2014-04-01 20:21:50 +00:00
|
|
|
#define MATH_FUN_1_TO_BOOL(py_name, c_name) \
|
2014-03-22 14:39:33 +00:00
|
|
|
mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj) { return MP_BOOL(c_name(mp_obj_get_float(x_obj))); } \
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);
|
|
|
|
|
2014-04-01 20:21:50 +00:00
|
|
|
#define MATH_FUN_1_TO_INT(py_name, c_name) \
|
2014-07-03 12:25:24 +00:00
|
|
|
mp_obj_t mp_math_ ## py_name(mp_obj_t x_obj) { return mp_obj_new_int((mp_int_t)MICROPY_FLOAT_C_FUN(c_name)(mp_obj_get_float(x_obj))); } \
|
2014-04-01 20:21:50 +00:00
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_## py_name ## _obj, mp_math_ ## py_name);
|
|
|
|
|
2014-04-17 16:11:03 +00:00
|
|
|
// These are also used by cmath.c
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \constant e - base of the natural logarithm
|
2014-04-17 16:11:03 +00:00
|
|
|
const mp_obj_float_t mp_math_e_obj = {{&mp_type_float}, M_E};
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \constant pi - the ratio of a circle's circumference to its diameter
|
2014-04-17 16:11:03 +00:00
|
|
|
const mp_obj_float_t mp_math_pi_obj = {{&mp_type_float}, M_PI};
|
2014-03-08 15:24:39 +00:00
|
|
|
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function sqrt(x)
|
|
|
|
/// Returns the square root of `x`.
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(sqrt, sqrt)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function pow(x, y)
|
|
|
|
/// Returns `x` to the power of `y`.
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_2(pow, pow)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function exp(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(exp, exp)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function expm1(x)
|
2014-03-12 21:31:41 +00:00
|
|
|
MATH_FUN_1(expm1, expm1)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function log(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(log, log)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function log2(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(log2, log2)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function log10(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(log10, log10)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function cosh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(cosh, cosh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function sinh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(sinh, sinh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function tanh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(tanh, tanh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function acosh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(acosh, acosh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function asinh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(asinh, asinh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function atanh(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(atanh, atanh)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function cos(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(cos, cos)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function sin(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(sin, sin)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function tan(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(tan, tan)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function acos(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(acos, acos)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function asin(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(asin, asin)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function atan(x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_1(atan, atan)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function atan2(y, x)
|
2014-03-08 15:24:39 +00:00
|
|
|
MATH_FUN_2(atan2, atan2)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function ceil(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_INT(ceil, ceil)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function copysign(x, y)
|
2014-03-20 21:26:51 +00:00
|
|
|
MATH_FUN_2(copysign, copysign)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function fabs(x)
|
2014-03-20 21:26:51 +00:00
|
|
|
MATH_FUN_1(fabs, fabs)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function floor(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_INT(floor, floor) //TODO: delegate to x.__floor__() if x is not a float
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function fmod(x, y)
|
2014-03-20 21:26:51 +00:00
|
|
|
MATH_FUN_2(fmod, fmod)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function isfinite(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_BOOL(isfinite, isfinite)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function isinf(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_BOOL(isinf, isinf)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function isnan(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_BOOL(isnan, isnan)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function trunc(x)
|
2014-04-01 20:21:50 +00:00
|
|
|
MATH_FUN_1_TO_INT(trunc, trunc)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function ldexp(x, exp)
|
2014-03-22 14:39:33 +00:00
|
|
|
MATH_FUN_2(ldexp, ldexp)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function erf(x)
|
|
|
|
/// Return the error function of `x`.
|
2014-03-22 14:39:33 +00:00
|
|
|
MATH_FUN_1(erf, erf)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function erfc(x)
|
|
|
|
/// Return the complementary error function of `x`.
|
2014-03-22 14:39:33 +00:00
|
|
|
MATH_FUN_1(erfc, erfc)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function gamma(x)
|
|
|
|
/// Return the gamma function of `x`.
|
2014-03-23 09:46:10 +00:00
|
|
|
MATH_FUN_1(gamma, tgamma)
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function lgamma(x)
|
|
|
|
/// return the natural logarithm of the gamma function of `x`.
|
2014-03-22 14:39:33 +00:00
|
|
|
MATH_FUN_1(lgamma, lgamma)
|
|
|
|
//TODO: factorial, fsum
|
|
|
|
|
|
|
|
// Functions that return a tuple
|
2014-08-10 16:50:28 +00:00
|
|
|
|
|
|
|
/// \function frexp(x)
|
|
|
|
/// Converts a floating-point number to fractional and integral components.
|
2014-03-22 20:44:15 +00:00
|
|
|
mp_obj_t mp_math_frexp(mp_obj_t x_obj) {
|
|
|
|
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);
|
2014-03-22 14:39:33 +00:00
|
|
|
}
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_frexp_obj, mp_math_frexp);
|
|
|
|
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function modf(x)
|
2014-03-22 20:44:15 +00:00
|
|
|
mp_obj_t mp_math_modf(mp_obj_t x_obj) {
|
|
|
|
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);
|
2014-03-22 14:39:33 +00:00
|
|
|
}
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_modf_obj, mp_math_modf);
|
|
|
|
|
|
|
|
// Angular conversions
|
2014-08-10 16:50:28 +00:00
|
|
|
|
|
|
|
/// \function radians(x)
|
2014-03-22 20:44:15 +00:00
|
|
|
mp_obj_t mp_math_radians(mp_obj_t x_obj) {
|
|
|
|
return mp_obj_new_float(mp_obj_get_float(x_obj) * M_PI / 180.0);
|
2014-03-22 14:39:33 +00:00
|
|
|
}
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_radians_obj, mp_math_radians);
|
|
|
|
|
2014-08-10 16:50:28 +00:00
|
|
|
/// \function degrees(x)
|
2014-03-22 20:44:15 +00:00
|
|
|
mp_obj_t mp_math_degrees(mp_obj_t x_obj) {
|
|
|
|
return mp_obj_new_float(mp_obj_get_float(x_obj) * 180.0 / M_PI);
|
2014-03-22 14:39:33 +00:00
|
|
|
}
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mp_math_degrees_obj, mp_math_degrees);
|
2014-03-20 21:30:38 +00:00
|
|
|
|
2014-03-08 15:24:39 +00:00
|
|
|
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) },
|
2014-03-20 16:39:22 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_e), (mp_obj_t)&mp_math_e_obj },
|
2014-03-08 15:24:39 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_pi), (mp_obj_t)&mp_math_pi_obj },
|
|
|
|
{ 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 },
|
2014-03-12 21:31:41 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_expm1), (mp_obj_t)&mp_math_expm1_obj },
|
2014-03-08 15:24:39 +00:00
|
|
|
{ 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 },
|
2014-03-20 21:26:51 +00:00
|
|
|
{ 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 },
|
2014-05-11 22:21:50 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_fmod), (mp_obj_t)&mp_math_fmod_obj },
|
2014-03-22 14:39:33 +00:00
|
|
|
{ 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 },
|
2014-03-20 21:26:51 +00:00
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_trunc), (mp_obj_t)&mp_math_trunc_obj },
|
2014-03-22 14:39:33 +00:00
|
|
|
{ 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 },
|
|
|
|
{ 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 },
|
2014-03-08 15:24:39 +00:00
|
|
|
};
|
|
|
|
|
2014-04-05 20:53:54 +00:00
|
|
|
STATIC const mp_obj_dict_t mp_module_math_globals = {
|
|
|
|
.base = {&mp_type_dict},
|
|
|
|
.map = {
|
|
|
|
.all_keys_are_qstrs = 1,
|
|
|
|
.table_is_fixed_array = 1,
|
2014-06-19 16:54:34 +00:00
|
|
|
.used = MP_ARRAY_SIZE(mp_module_math_globals_table),
|
|
|
|
.alloc = MP_ARRAY_SIZE(mp_module_math_globals_table),
|
2014-04-05 20:53:54 +00:00
|
|
|
.table = (mp_map_elem_t*)mp_module_math_globals_table,
|
|
|
|
},
|
2014-03-08 15:24:39 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
const mp_obj_module_t mp_module_math = {
|
|
|
|
.base = { &mp_type_module },
|
|
|
|
.name = MP_QSTR_math,
|
2014-04-05 20:53:54 +00:00
|
|
|
.globals = (mp_obj_dict_t*)&mp_module_math_globals,
|
2014-03-08 15:24:39 +00:00
|
|
|
};
|
|
|
|
|
2014-06-01 12:32:54 +00:00
|
|
|
#endif // MICROPY_PY_BUILTINS_FLOAT && MICROPY_PY_MATH
|