222 lines
8.3 KiB
C
222 lines
8.3 KiB
C
|
|
/*
|
|
* This file is part of the micropython-ulab project,
|
|
*
|
|
* https://github.com/v923z/micropython-ulab
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019-2020 Zoltán Vörös
|
|
*/
|
|
|
|
#ifndef __ULAB__
|
|
#define __ULAB__
|
|
|
|
// The pre-processor constants in this file determine how ulab behaves:
|
|
//
|
|
// - how many dimensions ulab can handle
|
|
// - which functions are included in the compiled firmware
|
|
// - whether the python syntax is numpy-like, or modular
|
|
// - whether arrays can be sliced and iterated over
|
|
// - which binary/unary operators are supported
|
|
//
|
|
// A considerable amount of flash space can be saved by removing (setting
|
|
// the corresponding constants to 0) the unnecessary functions and features.
|
|
|
|
// Setting this variable to 1 produces numpy-compatible firmware,
|
|
// i.e., functions can be called at the top level,
|
|
// without having to import the sub-modules (linalg and fft are exceptions,
|
|
// since those must be imported even in numpy)
|
|
#define ULAB_NUMPY_COMPATIBILITY (1)
|
|
|
|
// The maximum number of dimensions the firmware should be able to support
|
|
// Possible values lie between 1, and 4, inclusive
|
|
#define ULAB_MAX_DIMS 2
|
|
|
|
// By setting this constant to 1, iteration over array dimensions will be implemented
|
|
// as a function (ndarray_rewind_array), instead of writing out the loops in macros
|
|
// This reduces firmware size at the expense of speed
|
|
#define ULAB_HAS_FUNCTION_ITERATOR (0)
|
|
|
|
// If NDARRAY_IS_ITERABLE is 1, the ndarray object defines its own iterator function
|
|
// This option saves approx. 250 bytes of flash space
|
|
#define NDARRAY_IS_ITERABLE (1)
|
|
|
|
// Slicing can be switched off by setting this variable to 0
|
|
#define NDARRAY_IS_SLICEABLE (1)
|
|
|
|
// The default threshold for pretty printing. These variables can be overwritten
|
|
// at run-time via the set_printoptions() function
|
|
#define ULAB_HAS_PRINTOPTIONS (1)
|
|
#define NDARRAY_PRINT_THRESHOLD 10
|
|
#define NDARRAY_PRINT_EDGEITEMS 3
|
|
|
|
// determines, whether pi, and e are defined in ulab itself
|
|
#define ULAB_HAS_MATH_CONSTANTS (1)
|
|
|
|
// determines, whether the ndinfo function is available
|
|
#define ULAB_HAS_NDINFO (1)
|
|
|
|
// the ndarray binary operators
|
|
#define NDARRAY_HAS_BINARY_OPS (1)
|
|
#define NDARRAY_HAS_BINARY_OP_ADD (1)
|
|
#define NDARRAY_HAS_BINARY_OP_EQUAL (1)
|
|
#define NDARRAY_HAS_BINARY_OP_LESS (1)
|
|
#define NDARRAY_HAS_BINARY_OP_LESS_EQUAL (1)
|
|
#define NDARRAY_HAS_BINARY_OP_MORE (1)
|
|
#define NDARRAY_HAS_BINARY_OP_MORE_EQUAL (1)
|
|
#define NDARRAY_HAS_BINARY_OP_MULTIPLY (1)
|
|
#define NDARRAY_HAS_BINARY_OP_NOT_EQUAL (1)
|
|
#define NDARRAY_HAS_BINARY_OP_POWER (1)
|
|
#define NDARRAY_HAS_BINARY_OP_SUBTRACT (1)
|
|
#define NDARRAY_HAS_BINARY_OP_TRUE_DIVIDE (1)
|
|
|
|
#define NDARRAY_HAS_INPLACE_OPS (1)
|
|
#define NDARRAY_HAS_INPLACE_ADD (1)
|
|
#define NDARRAY_HAS_INPLACE_MULTIPLY (1)
|
|
#define NDARRAY_HAS_INPLACE_POWER (1)
|
|
#define NDARRAY_HAS_INPLACE_SUBTRACT (1)
|
|
#define NDARRAY_HAS_INPLACE_TRUE_DIVIDE (1)
|
|
|
|
// the ndarray unary operators
|
|
#define NDARRAY_HAS_UNARY_OPS (1)
|
|
#define NDARRAY_HAS_UNARY_OP_ABS (1)
|
|
#define NDARRAY_HAS_UNARY_OP_INVERT (1)
|
|
#define NDARRAY_HAS_UNARY_OP_LEN (1)
|
|
#define NDARRAY_HAS_UNARY_OP_NEGATIVE (1)
|
|
#define NDARRAY_HAS_UNARY_OP_POSITIVE (1)
|
|
|
|
// determines, which ndarray methods are available
|
|
#define NDARRAY_HAS_COPY (1)
|
|
#define NDARRAY_HAS_FLATTEN (1)
|
|
#define NDARRAY_HAS_ITEMSIZE (1)
|
|
#define NDARRAY_HAS_RESHAPE (1)
|
|
#define NDARRAY_HAS_SHAPE (1)
|
|
#define NDARRAY_HAS_SIZE (1)
|
|
#define NDARRAY_HAS_STRIDES (1)
|
|
#define NDARRAY_HAS_TOBYTES (1)
|
|
#define NDARRAY_HAS_TRANSPOSE (1)
|
|
|
|
// the approx module consumes about 4.5 kB of flash space
|
|
#ifndef ULAB_APPROX_MODULE
|
|
#define ULAB_APPROX_MODULE (1)
|
|
#define ULAB_APPROX_HAS_BISECT (1)
|
|
#define ULAB_APPROX_HAS_CURVE_FIT (0) // not fully implemented, set it to 0 for now
|
|
#define ULAB_APPROX_HAS_FMIN (1)
|
|
#define ULAB_APPROX_HAS_INTERP (1)
|
|
#define ULAB_APPROX_HAS_NEWTON (1)
|
|
#define ULAB_APPROX_HAS_TRAPZ (1)
|
|
#endif
|
|
|
|
// the compare module consumes about 12 kB of flash space
|
|
#ifndef ULAB_COMPARE_MODULE
|
|
#define ULAB_COMPARE_MODULE (1)
|
|
#define ULAB_COMPARE_HAS_CLIP (1)
|
|
#define ULAB_COMPARE_HAS_EQUAL (1)
|
|
#define ULAB_COMPARE_HAS_NOTEQUAL (1)
|
|
#define ULAB_COMPARE_HAS_MAXIMUM (1)
|
|
#define ULAB_COMPARE_HAS_MINIMUM (1)
|
|
#endif
|
|
|
|
// These are the array initialisation functions that
|
|
// are included at the top level, hence the missing
|
|
// module constant
|
|
#define ULAB_CREATE_HAS_ARANGE (1)
|
|
#define ULAB_CREATE_HAS_CONCATENATE (1)
|
|
#define ULAB_CREATE_HAS_EYE (1)
|
|
#define ULAB_CREATE_HAS_FULL (1)
|
|
#define ULAB_CREATE_HAS_LINSPACE (1)
|
|
#define ULAB_CREATE_HAS_LOGSPACE (1)
|
|
#define ULAB_CREATE_HAS_ONES (1)
|
|
#define ULAB_CREATE_HAS_ZEROS (1)
|
|
|
|
// FFT costs about 2.5 kB of flash space, independent of ULAB_MAX_DIMS
|
|
// Since all FFT module functions are just interfaces to the same kernel,
|
|
// with virtually no overhead, there is no point in defining ULAB_FFT_HAS_* constants
|
|
#ifndef ULAB_FFT_MODULE
|
|
#define ULAB_FFT_MODULE (1)
|
|
#endif
|
|
|
|
// the filter module occupies about 1 kB of flash space
|
|
#ifndef ULAB_FILTER_MODULE
|
|
#define ULAB_FILTER_MODULE (1)
|
|
#define ULAB_FILTER_HAS_CONVOLVE (1)
|
|
#define ULAB_FILTER_HAS_SOSFILT (1)
|
|
#endif
|
|
|
|
// linalg adds around 6 kB to the firmware
|
|
#ifndef ULAB_LINALG_MODULE
|
|
#define ULAB_LINALG_MODULE (1)
|
|
#define ULAB_LINALG_HAS_CHOLESKY (1)
|
|
#define ULAB_LINALG_HAS_DET (1)
|
|
#define ULAB_LINALG_HAS_DOT (1)
|
|
#define ULAB_LINALG_HAS_EIG (1)
|
|
#define ULAB_LINALG_HAS_INV (1)
|
|
#define ULAB_LINALG_HAS_NORM (1)
|
|
#define ULAB_LINALG_HAS_SIZE (1)
|
|
#define ULAB_LINALG_HAS_TRACE (1)
|
|
#endif
|
|
|
|
// numerical is about 12 kB
|
|
#ifndef ULAB_NUMERICAL_MODULE
|
|
#define ULAB_NUMERICAL_MODULE (1)
|
|
#define ULAB_NUMERICAL_HAS_ARGMINMAX (1)
|
|
#define ULAB_NUMERICAL_HAS_ARGSORT (1)
|
|
#define ULAB_NUMERICAL_HAS_CROSS (1)
|
|
#define ULAB_NUMERICAL_HAS_DIFF (1)
|
|
#define ULAB_NUMERICAL_HAS_FLIP (1)
|
|
#define ULAB_NUMERICAL_HAS_MEAN (1)
|
|
#define ULAB_NUMERICAL_HAS_MINMAX (1)
|
|
#define ULAB_NUMERICAL_HAS_ROLL (1)
|
|
#define ULAB_NUMERICAL_HAS_SORT (1)
|
|
#define ULAB_NUMERICAL_HAS_STD (1)
|
|
#define ULAB_NUMERICAL_HAS_SUM (1)
|
|
#endif
|
|
|
|
// poly requires approx. 2.5 kB
|
|
#ifndef ULAB_POLY_MODULE
|
|
#define ULAB_POLY_MODULE (1)
|
|
#define ULAB_POLY_HAS_POLYFIT (1)
|
|
#define ULAB_POLY_HAS_POLYVAL (1)
|
|
#endif
|
|
|
|
// vectorise (all functions) takes approx. 6 kB of flash space
|
|
#ifndef ULAB_VECTORISE_MODULE
|
|
#define ULAB_VECTORISE_MODULE (1)
|
|
#define ULAB_VECTORISE_HAS_ACOS (1)
|
|
#define ULAB_VECTORISE_HAS_ACOSH (1)
|
|
#define ULAB_VECTORISE_HAS_ARCTAN2 (1)
|
|
#define ULAB_VECTORISE_HAS_AROUND (1)
|
|
#define ULAB_VECTORISE_HAS_ASIN (1)
|
|
#define ULAB_VECTORISE_HAS_ASINH (1)
|
|
#define ULAB_VECTORISE_HAS_ATAN (1)
|
|
#define ULAB_VECTORISE_HAS_ATANH (1)
|
|
#define ULAB_VECTORISE_HAS_CEIL (1)
|
|
#define ULAB_VECTORISE_HAS_COS (1)
|
|
#define ULAB_VECTORISE_HAS_COSH (1)
|
|
#define ULAB_VECTORISE_HAS_DEGREES (1)
|
|
#define ULAB_VECTORISE_HAS_ERF (1)
|
|
#define ULAB_VECTORISE_HAS_ERFC (1)
|
|
#define ULAB_VECTORISE_HAS_EXP (1)
|
|
#define ULAB_VECTORISE_HAS_EXPM1 (1)
|
|
#define ULAB_VECTORISE_HAS_FLOOR (1)
|
|
#define ULAB_VECTORISE_HAS_GAMMA (1)
|
|
#define ULAB_VECTORISE_HAS_LGAMMA (1)
|
|
#define ULAB_VECTORISE_HAS_LOG (1)
|
|
#define ULAB_VECTORISE_HAS_LOG10 (1)
|
|
#define ULAB_VECTORISE_HAS_LOG2 (1)
|
|
#define ULAB_VECTORISE_HAS_RADIANS (1)
|
|
#define ULAB_VECTORISE_HAS_SIN (1)
|
|
#define ULAB_VECTORISE_HAS_SINH (1)
|
|
#define ULAB_VECTORISE_HAS_SQRT (1)
|
|
#define ULAB_VECTORISE_HAS_TAN (1)
|
|
#define ULAB_VECTORISE_HAS_TANH (1)
|
|
#define ULAB_VECTORISE_HAS_VECTORIZE (1)
|
|
#endif
|
|
|
|
// user-defined module
|
|
#ifndef ULAB_USER_MODULE
|
|
#define ULAB_USER_MODULE (0)
|
|
#endif
|
|
|
|
#endif
|