smartcarlib::utils Namespace Reference

Functions
template<typename AnyNumber >
constexpr AnyNumber	getAbsolute (AnyNumber number)
	Gets the absolute of the supplied number. More...
template<typename AnyNumber >
constexpr AnyNumber	getConstrain (AnyNumber number, AnyNumber min, AnyNumber max)
	Limit the number between a range. More...
template<typename AnyNumber >
AnyNumber	getMedian (AnyNumber unsortedNumbers[], const unsigned int &arraySize)
	Gets the median value out of the supplied number array. More...
template<typename AnyNumber >
constexpr AnyNumber	getMap (AnyNumber valueToMap, AnyNumber fromLow, AnyNumber fromHigh, AnyNumber toLow, AnyNumber toHigh)
	Maps a value from a range to another. More...
constexpr bool	areAlmostEqual (float a, float b)
	Compares two floating point numbers. More...

Function Documentation

areAlmostEqual()

constexpr bool smartcarlib::utils::areAlmostEqual ( float  a, float  b  )

constexpr

Compares two floating point numbers.

Parameters

a	The first floating point number to compare
b	The second floating point number to compare

Returns

true if the two numbers are amost equal, false otherwise

Example:

bool result = smartcarlib::utils::areAlmostEqual(0.000001, 0,0000012);
// `result` is `true`

Definition at line 124 of file Utilities.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getAbsolute()

template<typename AnyNumber >

constexpr AnyNumber smartcarlib::utils::getAbsolute ( AnyNumber  number )

constexpr

Gets the absolute of the supplied number.

Parameters

number

The number to get the absolute of

Returns

The absolute value

Example:

int num = -5;
num = smartcarlib::utils::getAbsolute(num);
// `num` is now `5`

Definition at line 24 of file Utilities.hpp.

Here is the caller graph for this function:

getConstrain()

template<typename AnyNumber >

constexpr AnyNumber smartcarlib::utils::getConstrain ( AnyNumber  number, AnyNumber  min, AnyNumber  max  )

constexpr

Limit the number between a range.

Parameters

number	The number to limit
min	The minimum limit of the range
max	The maximum limit of the range

Returns

The number unchanged if it was within the range, otherwise the lower limit of the range if it was smaller or the higher limit if it was larger

Example:

int num = -5;
num = smartcarlib::utils::getConstrain(num, 0, 100);
// `num` is now `0`

Definition at line 46 of file Utilities.hpp.

Here is the caller graph for this function:

getMap()

template<typename AnyNumber >

constexpr AnyNumber smartcarlib::utils::getMap ( AnyNumber  valueToMap, AnyNumber  fromLow, AnyNumber  fromHigh, AnyNumber  toLow, AnyNumber  toHigh  )

constexpr

Maps a value from a range to another.

Implemented as a templetized map of Arduino.

Parameters

valueToMap	The value to be mapped
fromLow	The lower limit of the initial range
fromHigh	The upper limit of the initial range
toLow	The lower limit of the final range
toHigh	The higher limit of the final range

Returns

The mapped value if initial range valid otherwise the lower limit of the target range

Example:

int num = 3;
 // Scale a `num` from 0-10 to 0-100
 num = smartcarlib::utils::getMap(num, 0, 10, 0, 100);
 // `num` is now `30`

Definition at line 104 of file Utilities.hpp.

Here is the caller graph for this function:

getMedian()

template<typename AnyNumber >

AnyNumber smartcarlib::utils::getMedian	(	AnyNumber	unsortedNumbers[],
		const unsigned int &	arraySize
	)

Gets the median value out of the supplied number array.

Parameters

unsortedNumbers	An array containing numbers
arraySize	Amount of numbers contained in the array

Returns

Median number of the supplied array

Example:

const int ARRAY_SIZE = 5;
int array[ARRAY_SIZE] = {0, 3, 4, 1, 15};
int median = smartcarlib::utils::getMedian(array, ARRAY_SIZE);
// `median` is `3`

Definition at line 66 of file Utilities.hpp.

Here is the caller graph for this function: