From 2fd8d102e9b94416c9b754f6e9b6c85efa294c72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20LUDWIG?= Date: Fri, 13 Sep 2024 15:35:19 +0200 Subject: [PATCH] feat: add `mathematics_max`, `mathematics_min` Also add `mathematics_max_values` and `mathematics_min_values` to check in array. --- lib/mathematics.c | 32 +++++++++++++++++++++++++++ lib/mathematics.h | 48 +++++++++++++++++++++++++++++++++++++++++ lib/string.h | 24 ++++++++++++++++----- test/mathematics_test.c | 40 ++++++++++++++++++++++++++++++++++ test/mathematics_test.h | 10 +++++++++ 5 files changed, 149 insertions(+), 5 deletions(-) diff --git a/lib/mathematics.c b/lib/mathematics.c index b8d14d9..957880a 100644 --- a/lib/mathematics.c +++ b/lib/mathematics.c @@ -36,3 +36,35 @@ unsigned long long mathematics_factorial(unsigned long long number) { int64_t mathematics_opposite(int64_t number) { return number * -1; } + +int64_t mathematics_max(int64_t number1, int64_t number2) { + return number1 > number2 ? number1 : number2; +} + +int64_t mathematics_max_values(int64_t *values, size_t values_length) { + int64_t max = 0; + if (values_length <= 0) { + return max; + } + max = values[0]; + for (size_t index = 1; index < values_length; index++) { + max = mathematics_max(max, values[index]); + } + return max; +} + +int64_t mathematics_min(int64_t number1, int64_t number2) { + return number1 > number2 ? number2 : number1; +} + +int64_t mathematics_min_values(int64_t *values, size_t values_length) { + int64_t min = 0; + if (values_length <= 0) { + return min; + } + min = values[0]; + for (size_t index = 1; index < values_length; index++) { + min = mathematics_min(min, values[index]); + } + return min; +} diff --git a/lib/mathematics.h b/lib/mathematics.h index c13bcbb..7a3f7e4 100644 --- a/lib/mathematics.h +++ b/lib/mathematics.h @@ -5,6 +5,7 @@ #include #include +#include #include "types.h" @@ -71,7 +72,54 @@ unsigned long long mathematics_factorial(unsigned long long number); * * @param number * @return int64_t + * + * @code + * mathematics_opposite(7) // -7 + * + * mathematics_opposite(-7) // 7 + * @endcode + * @since vTODO */ int64_t mathematics_opposite(int64_t number); +/** + * @brief Returns the largest number between 2 numbers. + * + * @param number1 + * @param number2 + * @return int64_t + * @since vTODO + */ +int64_t mathematics_max(int64_t number1, int64_t number2); + +/** + * @brief Returns the largest number between multiple numbers. If the array is empty, returns 0. + * + * @param values + * @param values_length + * @return int64_t + * @since vTODO + */ +int64_t mathematics_max_values(int64_t *values, size_t values_length); + +/** + * @brief Returns the smallest number between 2 numbers. + * + * @param number1 + * @param number2 + * @return int64_t + * @since vTODO + */ +int64_t mathematics_min(int64_t number1, int64_t number2); + +/** + * @brief Returns the smallest number between multiple numbers. If the array is empty, returns 0. + * + * @param values + * @param values_length + * @return int64_t + * @since vTODO + */ +int64_t mathematics_min_values(int64_t *values, size_t values_length); + #endif diff --git a/lib/string.h b/lib/string.h index b6ff5a0..98825db 100644 --- a/lib/string.h +++ b/lib/string.h @@ -224,6 +224,7 @@ bool string_get_is_substring(const string_t string, const string_t substring); * @param number * @param separator * @return string_t + * * @code * string_get_formatted_number(1000, " ") // "1 000" * string_get_formatted_number(1000, ",") // "1,000" @@ -270,7 +271,10 @@ bool string_ends_with(const string_t string, const string_t prefix); * @param string * @param substring * @return size_t - * @example string_position_of("hello world", 'e') // 2 + * + * @code + * string_position_of("hello world", 'e') // 2 + * @endcode * @since v4.2.0 */ size_t string_position_of(const string_t string, const char character); @@ -281,7 +285,10 @@ size_t string_position_of(const string_t string, const char character); * @param string * @param character * @return size_t - * @example string_last_position_of("hello world", 'o') // 8 + * + * @code + * string_last_position_of("hello world", 'o') // 8 + * @endcode * @since v4.2.0 */ size_t string_last_position_of(const string_t string, const char character); @@ -293,7 +300,10 @@ size_t string_last_position_of(const string_t string, const char character); * @param pad_string The string to pad the current string with, to the left. * @param target_length * @return string_t - * @example string_pad_start("hello", " ", 10) // " hello" + * + * @code + * string_pad_start("hello", " ", 10) // " hello" + * @endcode * @since vTODO */ string_t string_pad_start(const string_t string, const string_t pad_string, size_t target_length); @@ -304,8 +314,12 @@ string_t string_pad_start(const string_t string, const string_t pad_string, size * @param number * @param places * @return string_t - * @example zero_pad(1, 2) // "01" - * @example zero_pad(10, 2) // "10" + * + * @code + * string_zero_pad(1, 2) // "01" + * + * string_zero_pad(10, 2) // "10" + * @endcode * @since vTODO */ string_t string_zero_pad(uint64_t number, size_t places); diff --git a/test/mathematics_test.c b/test/mathematics_test.c index 276aa8b..d9760be 100644 --- a/test/mathematics_test.c +++ b/test/mathematics_test.c @@ -6,6 +6,11 @@ void mathematics_test() { mathematics_root_test(); mathematics_square_root_test(); mathematics_factorial_test(); + mathematics_opposite_test(); + mathematics_max_test(); + mathematics_max_values_test(); + mathematics_min_test(); + mathematics_min_values_test(); } void mathematics_absolute_value_test() { @@ -56,3 +61,38 @@ void mathematics_factorial_test() { assert(mathematics_factorial(9) == 362880); assert(mathematics_factorial(10) == 3628800); } + +void mathematics_opposite_test() { + assert(mathematics_opposite(-7) == 7); + assert(mathematics_opposite(7) == -7); +} + +void mathematics_max_test() { + assert(mathematics_max(0, 0) == 0); + assert(mathematics_max(0, 1) == 1); + assert(mathematics_max(2, 0) == 2); + assert(mathematics_max(54, 37) == 54); +} + +void mathematics_max_values_test() { + int64_t values[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}; + assert(mathematics_max_values(values, 10) == 9); + + int64_t values2[] = {8, 6, 4, 7}; + assert(mathematics_max_values(values2, 4) == 8); +} + +void mathematics_min_test() { + assert(mathematics_min(0, 0) == 0); + assert(mathematics_min(3, 5) == 3); + assert(mathematics_min(2, 1) == 1); + assert(mathematics_min(54, 37) == 37); +} + +void mathematics_min_values_test() { + int64_t values[] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9}; + assert(mathematics_min_values(values, 10) == 0); + + int64_t values2[] = {9, 6, 8, 7}; + assert(mathematics_min_values(values2, 4) == 6); +} diff --git a/test/mathematics_test.h b/test/mathematics_test.h index 7d13e99..18e5cc7 100644 --- a/test/mathematics_test.h +++ b/test/mathematics_test.h @@ -17,4 +17,14 @@ void mathematics_square_root_test(); void mathematics_factorial_test(); +void mathematics_opposite_test(); + +void mathematics_max_test(); + +void mathematics_max_values_test(); + +void mathematics_min_test(); + +void mathematics_min_values_test(); + #endif