std::size_t(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸŽ€ NAME πŸŽ€

Okay so this is std::size_t β€” page std::size_t(3) from the C++ Standard Library manual, section 3, very official πŸ’… β€” and the NAME line says, and I quote, std::size_t - std::size_t. That's it. That's the name. Iconic, low-effort, ate. ✨


🌸 Synopsis 🌸

So bestie, this type is defined in header a whole bunch of places, like it's showing up to every party:

  • Defined in header <cstddef>
  • Defined in header <cstdio>
  • Defined in header <cstdlib>
  • Defined in header <cstring>
  • Defined in header <ctime>
  • Defined in header <cuchar> (since C++17)
  • Defined in header <cwchar>

And the actual declaration is this:

typedef /*implementation-defined*/ size_t;

Basically no cap: std::size_t is the unsigned integer type of the result of the sizeof operator, and also of the sizeof... operator and the alignof operator (since C++11). Three operators, one type, she's booked and busy 🫢

Also the bit width of std::size_t is not less than 16. (since C++11) β€” so it's smol-ish minimum but never smaller than that, periodt.


πŸ¦‹ Notes πŸ¦‹

  • std::size_t can store the maximum size of a theoretically possible object of any type (including array). A type whose size cannot be represented by std::size_t is ill-formed 😭. On many platforms (an exception is systems with segmented addressing) std::size_t can safely store the value of any non-member pointer, in which case it is synonymous with std::uintptr_t. πŸ”₯
  • std::size_t is commonly used for array indexing and loop counting. Programs that use other types, such as unsigned int, for array indexing may fail on, e.g. 64-bit systems when the index exceeds UINT_MAX, or if it relies on 32-bit modular arithmetic. πŸ’€ so like. use the right type bestie.
  • When indexing C++ containers, such as std::string, std::vector, etc, the appropriate type is the member typedef size_type provided by such containers. It is usually defined as a synonym for std::size_t. Chef's kiss, consistent, we love a family resemblance πŸ“
  • It is unspecified whether the declaration of std::size_t is available in any other standard library header. An implementation may avoid introducing this name even when the standard requires std::size_t to be used. πŸ™ˆ (translation: don't assume, check your headers)
  • The integer literal suffix for std::size_t is any combination of z or (since C++23) Z with u or U β€” i.e. zu, zU, Zu, ZU, uz, uZ, Uz, or UZ. Eight whole options, she's flexible πŸ’–

🌈 Possible implementation 🌈

using size_t = decltype(sizeof(0)); // valid since C++11

Look at that. One line. Main character energy πŸ‘‘


✨ Example ✨

tiny note: the original page literally has a // Run this code link sitting above the snippet, and I'm passing that information along to you verbatim, bestie 🧚
#include <array>
#include <cstddef>
#include <iostream>

int main()
{
    std::array<std::size_t, 10> a;

    // Example with C++23 size_t literal
    for (auto i = 0uz; i != a.size(); ++i)
        std::cout << (a[i] = i) << ' ';
    std::cout << '\n';

    // Example of decrementing loop
    for (std::size_t i = a.size(); i--;)
        std::cout << a[i] << ' ';
    std::cout << '\n';

    // Note the naive decrementing loop:
    //  for (std::size_t i = a.size() - 1; i >= 0; --i) ...
    // is an infinite loop, because unsigned numbers are always non-negative
}

⭐ Output ⭐

0 1 2 3 4 5 6 7 8 9
9 8 7 6 5 4 3 2 1 0

That second loop is the vibe check passing, and that commented-out naive loop is the vibe check failing β€” unsigned numbers are always non-negative so i >= 0 is always true and you spiral forever πŸ˜­πŸ’€


πŸ’œ References πŸ’œ

Every single receipt, in order, not one skipped:

  • C++23 standard (ISO/IEC 14882:2023):
    • 6.8.4 Compound types [basic.compound] (p: 79-80)
    • 7.6.2.5 Sizeof [expr.sizeof] (p: 136)
    • 7.6.2.6 Alignof [expr.alignof] (p: 136)
    • 17.2.4 Sizes, alignments, and offsets [support.types.layout] (p: 504-505)
  • C++20 standard (ISO/IEC 14882:2020):
    • 6.8.3 Compound types [basic.compound] (p: 75-76)
    • 7.6.2.5 Sizeof [expr.sizeof] (p: 129-130)
    • 7.6.2.6 Alignof [expr.alignof] (p: 130)
    • 17.2.4 Sizes, alignments, and offsets [support.types.layout] (p: 507-508)
  • C++17 standard (ISO/IEC 14882:2017):
    • 6.9.2 Compound types [basic.compound] (p: 81-82)
    • 8.3.3 Sizeof [expr.sizeof] (p: 121-122)
    • 8.3.6 Alignof [expr.alignof] (p: 129)
    • 21.2.4 Sizes, alignments, and offsets [support.types.layout] (p: 479)
  • C++14 standard (ISO/IEC 14882:2014):
    • 3.9.2 Compound types [basic.compound] (p: 73-74)
    • 5.3.3 Sizeof [expr.sizeof] (p: 109-110)
    • 5.3.6 Alignof [expr.alignof] (p: 116)
    • 18.2 Types [support.types] (p: 443-444)
  • C++11 standard (ISO/IEC 14882:2011):
    • 5.3.3 Sizeof [expr.sizeof] (p: 111)
    • 5.3.6 Alignof [expr.alignof] (p: 116)
    • 18.2 Types [support.types] (p: 454-455)
  • C++03 standard (ISO/IEC 14882:2003):
    • 5.3.3 Sizeof [expr.sizeof] (p: 79)
  • C++98 standard (ISO/IEC 14882:1998):
    • 5.3.3 Sizeof [expr.sizeof] (p: 77)

πŸ‘‘ See also πŸ‘‘

  • ptrdiff_t β€” signed integer type returned when subtracting two pointers (typedef)
  • offsetof β€” byte offset from the beginning of a standard-layout type to specified member (function macro)
  • integer literals (since C++14) β€” binary, decimal, octal, or hexadecimal numbers of integer type
  • C documentation for size_t

Alright bestie, that's the whole page, nothing dropped, nothing invented 🫢 This one's from http://cppreference.com, dated 2024.06.10, and it lives at page std::size_t(3) in the manual β€” go forth and index your arrays correctly, mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from