foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
foxmath.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file foxmath.c
44  * @author foxBMS Team
45  * @date 2018-01-18 (date of creation)
46  * @updated 2018-01-18 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix MATH
49  *
50  * @brief mathlib function implementations
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "foxmath.h"
56 
57 /*========== Macros and Definitions =========================================*/
58 
59 /*========== Static Constant and Variable Definitions =======================*/
60 
61 /*========== Extern Constant and Variable Definitions =======================*/
62 
63 /*========== Static Function Prototypes =====================================*/
64 
65 /*========== Static Function Implementations ================================*/
66 
67 /*========== Extern Function Implementations ================================*/
68 
69 extern float MATH_linearInterpolation(float x1, float y1, float x2, float y2, float x_interpolate) {
70  float y_interpolate = 0.0f;
71  float slope = 0.0f;
72 
73  if (x1 != x2) {
74  /* Calculate slope */
75  slope = (y2 - y1) / (x2 - x1);
76  } else {
77  /* x values are identical -> no interpolation possible: return y1 value */
78  slope = 0;
79  }
80  /* Interpolate starting from x1/y1 */
81  y_interpolate = y1 + (slope * (x_interpolate - x1));
82 
83  return y_interpolate;
84 }
85 
86 extern uint16_t MATH_swapBytes_uint16_t(uint16_t val) {
87  return (val << 8) | (val >> 8);
88 }
89 
90 extern uint32_t MATH_swapBytes_uint32_t(uint32_t val) {
91  val = ((val << 8) & 0xFF00FF00u) | ((val >> 8) & 0xFF00FFu);
92  return (val << 16) | (val >> 16);
93 }
94 
95 extern uint64_t MATH_swapBytes_uint64_t(uint64_t val) {
96  val = ((val << 8) & 0xFF00FF00FF00FF00ull) | ((val >> 8) & 0x00FF00FF00FF00FFull);
97  val = ((val << 16) & 0xFFFF0000FFFF0000ull) | ((val >> 16) & 0x0000FFFF0000FFFFull);
98  return (val << 32) | (val >> 32);
99 }
100 
101 extern float MATH_minimumOfTwoFloats(float value1, float value2) {
102  return fminf(value1, value2);
103 }
104 
105 extern int32_t MATH_AbsInt32(int32_t value) {
106  int32_t absValue = INT32_MAX;
107  if (value != INT32_MIN) {
108  absValue = labs(value);
109  }
110  return absValue;
111 }
112 
113 extern int64_t MATH_AbsInt64(int64_t value) {
114  int64_t absValue = INT64_MAX;
115  if (value != INT64_MIN) {
116  absValue = llabs(value);
117  }
118  return absValue;
119 }
120 
121 /*========== Externalized Static Function Implementations (Unit Test) =======*/
MATH_swapBytes_uint32_t
uint32_t MATH_swapBytes_uint32_t(uint32_t val)
Swap bytes of uint32_t value.
Definition: foxmath.c:90
MATH_AbsInt32
int32_t MATH_AbsInt32(int32_t value)
Returns the absolute value of passed int32_t value.
Definition: foxmath.c:105
MATH_swapBytes_uint16_t
uint16_t MATH_swapBytes_uint16_t(uint16_t val)
Swap bytes of uint16_t value.
Definition: foxmath.c:86
MATH_minimumOfTwoFloats
float MATH_minimumOfTwoFloats(float value1, float value2)
Returns the minimum of the passed float values.
Definition: foxmath.c:101
foxmath.h
math library for often used math functions
MATH_linearInterpolation
float MATH_linearInterpolation(float x1, float y1, float x2, float y2, float x_interpolate)
Linear inter-/extrapolates a third point according to two given points.
Definition: foxmath.c:69
MATH_swapBytes_uint64_t
uint64_t MATH_swapBytes_uint64_t(uint64_t val)
Swap bytes of uint64_t value.
Definition: foxmath.c:95
MATH_AbsInt64
int64_t MATH_AbsInt64(int64_t value)
Returns the absolute value of passed int64_t value.
Definition: foxmath.c:113