foxmath.h File Reference

math library for often used math functions More...

#include <math.h>
#include <stdint.h>
#include <float.h>
#include <stdlib.h>

Include dependency graph for foxmath.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	UNIT_CONVERSION_FACTOR_1000_INTEGER   (1000)
#define	UNIT_CONVERSION_FACTOR_10_FLOAT   (10.0f)
#define	UNIT_CONVERSION_FACTOR_100_FLOAT   (100.0f)
#define	UNIT_CONVERSION_FACTOR_1000_FLOAT   (1000.0f)

Functions
void	MATH_StartupSelfTest (void)
	: self test for math functions that can be called at startup More...
float_t	MATH_LinearInterpolation (const float_t x1, const float_t y1, const float_t x2, const float_t y2, const float_t x_interpolate)
	Linear inter-/extrapolates a third point according to two given points. More...
uint16_t	MATH_SwapBytesUint16_t (const uint16_t val)
	Swap bytes of uint16_t value. More...
uint32_t	MATH_SwapBytesUint32_t (const uint32_t val)
	Swap bytes of uint32_t value. More...
uint64_t	MATH_SwapBytesUint64_t (const uint64_t val)
	Swap bytes of uint64_t value. More...
float_t	MATH_MinimumOfTwoFloats (const float_t value1, const float_t value2)
	Returns the minimum of the passed float values. More...
uint8_t	MATH_MinimumOfTwoUint8_t (const uint8_t value1, const uint8_t value2)
	Returns the minimum of the passed uint8_t values. More...
uint16_t	MATH_MinimumOfTwoUint16_t (const uint16_t value1, const uint16_t value2)
	Returns the minimum of the passed uint16_t values. More...
int32_t	MATH_AbsInt32_t (const int32_t value)
	Returns the absolute value of passed int32_t value. More...
int64_t	MATH_AbsInt64_t (const int64_t value)
	Returns the absolute value of passed int64_t value. More...

Detailed Description

math library for often used math functions

Copyright

© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

• ″This product uses parts of foxBMS®″
• ″This product includes parts of foxBMS®″
• ″This product is derived from foxBMS®″

Author

foxBMS Team

Date

2018-01-18 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

MATH

This header file contains the different math function declarations. Currently the following functions are supported:

• Slope
• Linear interpolation

Definition in file foxmath.h.

Macro Definition Documentation

UNIT_CONVERSION_FACTOR_1000_FLOAT

#define UNIT_CONVERSION_FACTOR_1000_FLOAT   (1000.0f)

Definition at line 78 of file foxmath.h.

UNIT_CONVERSION_FACTOR_1000_INTEGER

#define UNIT_CONVERSION_FACTOR_1000_INTEGER   (1000)

Add defines for unit conversions

Definition at line 75 of file foxmath.h.

UNIT_CONVERSION_FACTOR_100_FLOAT

#define UNIT_CONVERSION_FACTOR_100_FLOAT   (100.0f)

Definition at line 77 of file foxmath.h.

UNIT_CONVERSION_FACTOR_10_FLOAT

#define UNIT_CONVERSION_FACTOR_10_FLOAT   (10.0f)

Definition at line 76 of file foxmath.h.

Function Documentation

MATH_AbsInt32_t()

int32_t MATH_AbsInt32_t

(

const int32_t

value

)

Returns the absolute value of passed int32_t value.

Parameters

[in]

value

integer value

Returns

absolute value or INT32_MAX if INT32_MIN is passed

Definition at line 152 of file foxmath.c.

MATH_AbsInt64_t()

int64_t MATH_AbsInt64_t

(

const int64_t

value

)

Returns the absolute value of passed int64_t value.

Parameters

[in]

value

integer value

Returns

absolute value or INT64_MAX if INT64_MIN is passed

Definition at line 160 of file foxmath.c.

MATH_LinearInterpolation()

float_t MATH_LinearInterpolation	(	const float_t	x1,
		const float_t	y1,
		const float_t	x2,
		const float_t	y2,
		const float_t	x_interpolate
	)

Linear inter-/extrapolates a third point according to two given points.

Parameters

x1	x-value of point 1
y1	y-value of point 1
x2	x-value of point 2
y2	y-value of point 2
x_interpolate	x value of interpolation point

Returns

interpolated value (float)

Definition at line 84 of file foxmath.c.

MATH_MinimumOfTwoFloats()

float_t MATH_MinimumOfTwoFloats	(	const float_t	value1,
		const float_t	value2
	)

Returns the minimum of the passed float values.

Parameters

[in]	value1	value 1
[in]	value2	value 2

Returns

minimum value

Definition at line 132 of file foxmath.c.

MATH_MinimumOfTwoUint16_t()

uint16_t MATH_MinimumOfTwoUint16_t	(	const uint16_t	value1,
		const uint16_t	value2
	)

Returns the minimum of the passed uint16_t values.

Parameters

[in]	value1	value 1
[in]	value2	value 2

Returns

minimum value

Definition at line 144 of file foxmath.c.

MATH_MinimumOfTwoUint8_t()

uint8_t MATH_MinimumOfTwoUint8_t	(	const uint8_t	value1,
		const uint8_t	value2
	)

Returns the minimum of the passed uint8_t values.

Parameters

[in]	value1	value 1
[in]	value2	value 2

Returns

minimum value

Definition at line 136 of file foxmath.c.

MATH_StartupSelfTest()

void MATH_StartupSelfTest

(

void

)

: self test for math functions that can be called at startup

: This self test is intended to be called at startup. It will assert if one of the assumptions is violated. This function can be used to make sure that features of foxmath that are currently not used by the code are working nevertheless as expected.

Definition at line 79 of file foxmath.c.

Here is the call graph for this function:

MATH_SwapBytesUint16_t()

uint16_t MATH_SwapBytesUint16_t

(

const uint16_t

val

)

Swap bytes of uint16_t value.

Parameters

val	value to swap bytes: 0x1234 -> 0x3412

Definition at line 107 of file foxmath.c.

MATH_SwapBytesUint32_t()

uint32_t MATH_SwapBytesUint32_t

(

const uint32_t

val

)

Swap bytes of uint32_t value.

Parameters

val	value to swap bytes: 0x12345678 -> 0x78563412

Definition at line 111 of file foxmath.c.

MATH_SwapBytesUint64_t()

uint64_t MATH_SwapBytesUint64_t

(

const uint64_t

val

)

Swap bytes of uint64_t value.

Parameters

val	value to swap bytes: 0x1122334455667788 -> 0x8877665544332211

Definition at line 119 of file foxmath.c.