aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorclyne <clyne@bitgloo.com>2020-06-26 18:56:13 -0400
committerGitHub <noreply@github.com>2020-06-26 18:56:13 -0400
commit8b2e3c7bc5e6f66363c6256f5f7eb57e366d5b16 (patch)
tree124911b4536d05c2b885e33cb2f0cf235b655f6e /README.md
parentf26a6dc4d527d0ae6d51ae61701a7e908e7fdb28 (diff)
Update "how it works" section
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index aa99175..f2c55e1 100644
--- a/README.md
+++ b/README.md
@@ -27,22 +27,26 @@ Try it [on Compiler Explorer](https://godbolt.org/z/T-MFoh).
The basic structure of `to_string` is shown below:
```cpp
-template<auto N, unsigned int base, /* N type-check and base bounds-check */>
+template<auto N, unsigned int base, typename char_type, /* N type-check and base bounds-check */>
struct to_string_t {
- char buf[]; // Size selection explained later.
- constexpr to_string_t() {} // Converts the integer to a string stored in buf.
- constexpr operator char *() {} // These allow for the object to be implicitly converted
- constexpr operator const char *() {} // to a character pointer.
+ char_type buf[]; // Size selection explained later.
+ constexpr to_string_t() {} // Converts the integer to a string stored in buf.
+ constexpr operator char_type *() {} // These allow for the object to be implicitly converted
+ constexpr operator const char_type *() {} // to a character pointer.
+
+ // begin() and end() are supported too.
};
-template<auto N, unsigned int base = 10>
-to_string_t<N, base> to_string; // Simplifies usage: to_string_t<N, base>() becomes to_string<N, base>.
+template<auto N, unsigned int base = 10, typename char_type = char>
+constexpr to_string_t<N, base, char_type> to_string; // Simplifies usage, e.g. to_string_t<367>() becomes to_string<367>.
```
Since the number and base are template parameters, each differing `to_string` use will get its own character buffer.
The integer/string conversion is done using a simple method I learned over the years, where the string is built in reverse using `n % base` to calculate the value of the lowest digit:
+(*Note: The below examples of code are not up-to-date, though they still give a general idea of how `to_string` works.*)
+
```cpp
constexpr to_string_t() {
auto ptr = buf + sizeof(buf) / sizeof(buf[0]);