From 8b2e3c7bc5e6f66363c6256f5f7eb57e366d5b16 Mon Sep 17 00:00:00 2001 From: clyne Date: Fri, 26 Jun 2020 18:56:13 -0400 Subject: [PATCH] Update "how it works" section --- README.md | 18 +++++++++++------- 1 file 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 +template 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 -to_string_t to_string; // Simplifies usage: to_string_t() becomes to_string. +template +constexpr to_string_t 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]);