leonetienne/GeneralUtility
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Better comments

Browse Source
This commit is contained in:
Leonetienne 2022-02-27 19:34:53 +01:00
parent 50957fb9a3
commit efec74dfbb
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Src/GeneralUtility.h
View File

@ -19,7 +19,7 @@ public:
//! Will divide a number of arbitrary base in `dividend` by an integer divisor. //! Will divide a number of arbitrary base in `dividend` by an integer divisor.
//! This is a specific helper function for the base conversion functions. //! This is a specific helper function for the base conversion functions.
//! \param dividend The number to be divided in string form //! \param dividend The number to be divided in listlike container-form (such as a string)
//! \param divisor The integer divisor //! \param divisor The integer divisor
//! \param set The set/base of `dividend` //! \param set The set/base of `dividend`
//! \return A pair of the result. (result, rest) //! \return A pair of the result. (result, rest)
@ -27,7 +27,7 @@ public:
static std::pair<T_Container, int> DigitstringDivision(const T_Container& dividend, const unsigned int divisor, const T_Container& set); static std::pair<T_Container, int> DigitstringDivision(const T_Container& dividend, const unsigned int divisor, const T_Container& set);
//! Will convert a number of arbitrary base to base 10 //! Will convert a number of arbitrary base to base 10
//! \param num A string representing the number //! \param num A listlike container representing the number (such as a string)
//! \param set The set/base of the number //! \param set The set/base of the number
//! \return A 64-bit integer representing the number //! \return A 64-bit integer representing the number
template <class T_Container> template <class T_Container>
@ -36,13 +36,13 @@ public:
//! Will convert a number to an arbitrary base. //! Will convert a number to an arbitrary base.
//! This just a wrapper for BaseX_2_Y. //! This just a wrapper for BaseX_2_Y.
//! \param num The number to be converted //! \param num The number to be converted
//! \param set The desired set/base for the output to be in //! \param set The desired set/base for the output to be in. Should be a listlike container (such as a string)
//! \return `num` in base `set` //! \return `num` in base `set`
template <class T_Container> template <class T_Container>
static T_Container Base10_2_X(const std::uint64_t& num, const T_Container& set, const std::uint32_t minOutLen = 1); static T_Container Base10_2_X(const std::uint64_t& num, const T_Container& set, const std::uint32_t minOutLen = 1);
//! Will convert a number from an arbitrary base to another arbitrary base. //! Will convert a number from an arbitrary base to another arbitrary base.
//! \param num A string representation of a number //! \param num A representation of a number in a listlike container (such as a string)
//! \param set_in The set/base of the input //! \param set_in The set/base of the input
//! \param set_out The desired set/base to output //! \param set_out The desired set/base to output
//! \param minLen The minimum output length. Setting this will result in zero-padded output (Like, 00000001 instead of 1) //! \param minLen The minimum output length. Setting this will result in zero-padded output (Like, 00000001 instead of 1)