Merge pull request #223 from elbeno/update-docs

Update documentation for `byterator`

Author: elbeno

README.md

@@ -11,7 +11,7 @@ Some of the extras are available only with C++20 or later.
 
 *stdx* supports:
 
-- clang 14 through 19
+- clang 14 through 20
 - gcc 12 through 14
 
 See the [full documentation](https://intel.github.io/cpp-std-extensions/).

docs/bit.adoc

@@ -125,8 +125,8 @@ integral type that will fit a compile-time value.
 
 [source,cpp]
 ----
-constexpr auto x = stdx::smallest_uint<42>();   // std::uint8_t{}
-constexpr auto y = stdx::smallest_uint<1337>(); // std::uint16_t{}
+constexpr auto x = stdx::smallest_uint<42>();   // std::uint8_t{42}
+constexpr auto y = stdx::smallest_uint<1337>(); // std::uint16_t{1337}
 
 // smallest_uint_t is the type of a call to smallest_uint
 using T = stdx::smallest_uint_t<1337>; // std::uint16_t

docs/byterator.adoc

@@ -72,6 +72,10 @@ i.writeu16(v16);        // write and advance
 auto v32 = i.peeku32(); // read value without advancing
 v32 = i.readu32();      // read and advance
 i.writeu32(v32);        // write and advance
+
+auto v64 = i.peeku64(); // read value without advancing
+v64 = i.readu64();      // read and advance
+i.writeu64(v64);        // write and advance
 ----
 
 These convenience functions are implemented by function templates that offer

docs/intro.adoc

@@ -21,8 +21,11 @@ The following compilers are supported:
 * clang 16
 * clang 17
 * clang 18
+* clang 19
+* clang 20
 * gcc 12
 * gcc 13
+* gcc 14
 
 In general, `stdx` supports the C++17 standard; however some functionality is
 available only in 20 and later.

include/stdx/bit.hpp

@@ -421,13 +421,13 @@ template <typename T> constexpr auto bit_size() -> std::size_t {
 
 template <std::size_t N> CONSTEVAL auto smallest_uint() {
     if constexpr (N <= std::numeric_limits<std::uint8_t>::digits) {
-        return std::uint8_t{};
+        return std::uint8_t{N};
     } else if constexpr (N <= std::numeric_limits<std::uint16_t>::digits) {
-        return std::uint16_t{};
+        return std::uint16_t{N};
     } else if constexpr (N <= std::numeric_limits<std::uint32_t>::digits) {
-        return std::uint32_t{};
+        return std::uint32_t{N};
     } else {
-        return std::uint64_t{};
+        return std::uint64_t{N};
     }
 }