fix/refactor: fix bug in computerscience/core module, improve formatting

Author: alexeev-dev

.gitignore

@@ -0,0 +1,34 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+build/

README.md

@@ -14,9 +14,6 @@
 > [!CAUTION]
 > At the moment, libnumerixpp is under active development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).
 
-> [!CAUTION]
-> libnumerixpp in development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).
-
 libnumerixpp is a powerful, cross-platofrm C++ library designed for high-performance numerical computing in the domains of physics, mathematics, and computer science.
 
 You can join to our [small russian telegram blog](https://t.me/hex_warehouse).

examples/example-1.cpp

@@ -21,7 +21,8 @@ auto main() -> int {
 	double const final_velocity = physics::kinematics::calculate_final_velocity(10.0, 10.0, 10.0);
 	std::cout << "final velocity (10.0, 10.0, 10.0) = " << final_velocity << '\n';
 
-	double const final_position = physics::kinematics::calculate_final_position(10.0, 10.0, 10.0, 10.0);
+	double const final_position =
+		physics::kinematics::calculate_final_position(10.0, 10.0, 10.0, 10.0);
 	std::cout << "final position (10.0, 10.0, 10.0, 10.0) = " << final_velocity << '\n';
 
 	return 0;

examples/example-2.cpp

@@ -50,10 +50,10 @@ auto main() -> int {
 
 	double const best_pow_val = 100;
 	double const pow_results[5] = { mathematics::oldApproximatePower(10.0, 2.0),
-							  mathematics::anotherApproximatePower(10.0, 2.0),
-							  mathematics::binaryPower(10.0, 2),
-							  mathematics::fastPowerDividing(10.0, 2.0),
-							  mathematics::fastPowerFractional(10.0, 2.0) };
+									mathematics::anotherApproximatePower(10.0, 2.0),
+									mathematics::binaryPower(10.0, 2),
+									mathematics::fastPowerDividing(10.0, 2.0),
+									mathematics::fastPowerFractional(10.0, 2.0) };
 
 	std::cout << "0 oldApproximatePower	   : base 10 exponent 2: " << pow_results[0] << '\n';
 	std::cout << "1 anotherApproximatePower: base 10 exponent 2: " << pow_results[1] << '\n';

examples/example-3.cpp

@@ -14,13 +14,14 @@ auto main() -> int {
 	int const decimal_number2 = computerscience::convertBinaryToDecimal(binary_number);
 	std::string hexadecimal_number = computerscience::convertDecimalToHexadecimal(decimal_number);
 	int const decimal_number3 = computerscience::convertHexadecimalToDecimal(hexadecimal_number);
-	std::string const hexadecimal_number2 = computerscience::convertBinaryToHexadecimal(binary_number);
-	std::string const binary_number2 = computerscience::convertHexadecimalToBinary(hexadecimal_number);
+	std::string const hexadecimal_number2 =
+		computerscience::convertBinaryToHexadecimal(binary_number);
+	std::string const binary_number2 =
+		computerscience::convertHexadecimalToBinary(hexadecimal_number);
 	long long const bytes = 1024 * 1024;
 
 	std::cout << "Convert decimal " << decimal_number << " to binary: " << binary_number << '\n';
-	std::cout << "Convert binary " << binary_number << " to decimal: " << decimal_number2
-			  << '\n';
+	std::cout << "Convert binary " << binary_number << " to decimal: " << decimal_number2 << '\n';
 	std::cout << "Convert decimal " << decimal_number << " to hexadecimal: " << hexadecimal_number
 			  << '\n';
 	std::cout << "Convert hexadecimal " << hexadecimal_number << " to decimal: " << decimal_number3
@@ -29,8 +30,7 @@ auto main() -> int {
 			  << '\n';
 	std::cout << "Convert hexadecimal " << hexadecimal_number << " to binary: " << binary_number2
 			  << '\n';
-	std::cout << "Convert " << bytes << ": " << computerscience::humanizeBytesSize(bytes)
-			  << '\n';
+	std::cout << "Convert " << bytes << ": " << computerscience::humanizeBytesSize(bytes) << '\n';
 
 	return 0;
 }

examples/example-4.cpp

@@ -6,7 +6,7 @@
 #include "libnumerixpp/libnumerixpp.hpp"
 #include "libnumerixpp/mathematics/equations.hpp"
 
-void test_eq_sa(double (*f_eq)(double), double x0, const std::string& eq) {
+void test_eq_sa(double (*f_eq)(double), double x0, const std::string &eq) {
 	int const iterations = 100;
 
 	double z = NAN;

format-code.py

@@ -93,9 +93,9 @@ def main():
 		for file in files: 
 			if file.endswith(cpp_extensions):
 				print(f"{BOLD}Format {file}: {root}/{file}{NC}")
-				os.system(f"{CLANG_FORMAT} -i -style=file {root}/{file}")
-				os.system(f'clang-tidy --fix {root}/{file}')
 				os.system(f'codespell -w {root}/{file}')
+				os.system(f'clang-tidy --fix {root}/{file}')
+				os.system(f"{CLANG_FORMAT} -i -style=file {root}/{file}")
 				print(f"{GREEN}Formatting completed successfully: {root}/{file}{NC}")
 				convert_file(f'{root}/{file}', "4", "tabs")
 

include/libnumerixpp/computerscience/core.hpp

@@ -16,69 +16,69 @@
  */
 namespace computerscience {
 
-/**
- * @brief	   convert decimal to binary
- *
- * @param[in]  decimal	The decimal
- *
- * @return	   binary number string
- */
-auto convert_decimal_to_binary(int decimal) -> std::string;
+	/**
+	 * @brief	   convert decimal to binary
+	 *
+	 * @param[in]  decimal	The decimal
+	 *
+	 * @return	   binary number string
+	 */
+	auto convert_decimal_to_binary(int decimal) -> std::string;
 
-/**
- * @brief	   convert binary to decimal
- *
- * @param	   binary  The binary
- *
- * @return	   decimal integer
- */
-auto convert_binary_to_decimal(std::string &binary) -> int;
+	/**
+	 * @brief	   convert binary to decimal
+	 *
+	 * @param	   binary  The binary
+	 *
+	 * @return	   decimal integer
+	 */
+	auto convert_binary_to_decimal(std::string &binary) -> int;
 
-/**
- * @brief	   convert decimal to hexadecimal
- *
- * @param[in]  decimal	The decimal
- *
- * @return	   hexadecimal number string
- */
-auto convert_decimal_to_hexadecimal(int decimal) -> std::string;
+	/**
+	 * @brief	   convert decimal to hexadecimal
+	 *
+	 * @param[in]  decimal	The decimal
+	 *
+	 * @return	   hexadecimal number string
+	 */
+	auto convert_decimal_to_hexadecimal(int decimal) -> std::string;
 
-/**
- * @brief	   convert hexadecimal to decimal
- *
- * @param	   hexadecimal	The hexadecimal
- *
- * @return	   decimal integer
- */
-auto convert_hexadecimal_to_decimal(std::string &hexadecimal) -> int;
+	/**
+	 * @brief	   convert hexadecimal to decimal
+	 *
+	 * @param	   hexadecimal	The hexadecimal
+	 *
+	 * @return	   decimal integer
+	 */
+	auto convert_hexadecimal_to_decimal(std::string &hexadecimal) -> int;
 
-/**
- * @brief	   convert binary to hexadecimal
- *
- * @param	   binary  The binary
- *
- * @return	   hexadecimal number string
- */
-auto convert_binary_to_hexadecimal(std::string &binary) -> std::string;
+	/**
+	 * @brief	   convert binary to hexadecimal
+	 *
+	 * @param	   binary  The binary
+	 *
+	 * @return	   hexadecimal number string
+	 */
+	auto convert_binary_to_hexadecimal(std::string &binary) -> std::string;
 
-/**
- * @brief	   convert hexadecimal to binary
- *
- * @param[in]  hexadecimal	The hexadecimal
- *
- * @return	   binary number string
- */
-auto convert_hexadecimal_to_binary(std::string hexadecimal) -> std::string;
+	/**
+	 * @brief	   convert hexadecimal to binary
+	 *
+	 * @param[in]  hexadecimal	The hexadecimal
+	 *
+	 * @return	   binary number string
+	 */
+	auto convert_hexadecimal_to_binary(std::string hexadecimal) -> std::string;
 
-/**
- * @brief	   Scale bytes to its proper format
- *
- * @param[in]  bytes   The bytes
- * @param[in]  suffix  The suffix
- *
- * @return	   humanized size
- */
-auto humanize_bytes_size(long long bytes, const std::string &suffix = "B") -> std::string;
+	/**
+	 * @brief	   Scale bytes to its proper format
+	 *
+	 * @param[in]  bytes   The bytes
+	 * @param[in]  suffix  The suffix
+	 *
+	 * @return	   humanized size
+	 */
+	auto humanize_bytes_size(long long bytes, const std::string &suffix = "B") -> std::string;
 }  // namespace computerscience
 
 #endif	// LIBNUMERIXPP_COMPUTERSCIENCE_CORE_HPP