User-defined literals (since C++11)

Allows integer, floating-point, character, and string literals to produce objects of user-defined type by defining a user-defined suffix.

Syntax

A user-defined literal is an expression of any of the following forms

If a token matches a user-defined literal syntax and a regular literal syntax, it is assumed to be a regular literal (that is, it's impossible to overload LL in 123LL ).

When the compiler encounters a user-defined literal with ud-suffix X , it performs unqualified name lookup , looking for a function with the name operator "" X . If the lookup does not find a declaration, the program is ill-formed. Otherwise,

long double operator ""_w(long double);
std::string operator ""_w(const char16_t*, size_t);
unsigned    operator ""_w(const char*);
int main()
{
    1.2_w;    // calls operator ""_w(1.2L)
    u"one"_w; // calls operator ""_w(u"one", 3)
    12_w;     // calls operator ""_w("12")
    "two"_w;  // error: no applicable literal operator
}

When string literal concatenation takes place in translation phase 6 , user-defined string literals are concatenated as well, and their ud-suffix es are ignored for the purpose of concatenation, except that only one suffix may appear on all concatenated literals:

int main()
{
    L"A" "B" "C"_x;  // OK: same as L"ABC"_x
    "P"_x "Q" "R"_y; // error: two different ud-suffixes (_x and _y)
}

Literal operators

The function called by a user-defined literal is known as literal operator (or, if it's a template, literal operator template ). It is declared just like any other function or function template at namespace scope (it may also be a friend function, an explicit instantiation or specialization of a function template, or introduced by a using-declaration), except for the following restrictions:

The name of this function can have one of the two forms:

ud-suffix must begin with the underscore _ : the suffixes that do not begin with the underscore are reserved for the literal operators provided by the standard library. It cannot contain double underscores __ as well: such suffixes are also reserved.

If the literal operator is a template, it must have an empty parameter list and can have only one template parameter, which must be a constant template parameter pack with element type char (in which case it is known as a numeric literal operator template ):

template<char...>
double operator ""_x();

struct A { constexpr A(const char*); };
template<A a>
A operator ""_a();

Only the following parameter lists are allowed on literal operators:

Default arguments are not allowed.

C language linkage is not allowed.

Other than the restrictions above, literal operators and literal operator templates are normal functions (and function templates), they can be declared inline or constexpr, they may have internal or external linkage, they can be called explicitly, their addresses can be taken, etc.

#include <string>
void        operator ""_km(long double); // OK, will be called for 1.0_km
void        operator "" _km(long double); // same as above, deprecated
std::string operator ""_i18n(const char*, std::size_t); // OK
template<char...>
double operator ""_pi(); // OK
float  operator ""_e(const char*); // OK
// error: suffix must begin with underscore
float operator ""Z(const char*);
// error: all names that begin with underscore followed by uppercase
// letter are reserved (NOTE: a space between "" and _).
double operator"" _Z(long double);
// OK. NOTE: no space between "" and _.
double operator""_Z(long double);
// OK: literal operators can be overloaded
double operator ""_Z(const char* args);
int main() {}

Notes

Since the introduction of user-defined literals, the code that uses format macro constants for fixed-width integer types with no space after the preceding string literal became invalid: std:: printf ( "%" PRId64 " \n " , INT64_MIN ) ; has to be replaced by std:: printf ( "%" PRId64 " \n " , INT64_MIN ) ; .

Due to maximal munch , user-defined integer and floating point literals ending in p , P , (since C++17) e and E , when followed by the operators + or - , must be separated from the operator with whitespace or parentheses in the source:

long double operator""_E(long double);
long double operator""_a(long double);
int operator""_p(unsigned long long);
auto x = 1.0_E+2.0;   // error
auto y = 1.0_a+2.0;   // OK
auto z = 1.0_E +2.0;  // OK
auto q = (1.0_E)+2.0; // OK
auto w = 1_p+2;       // error
auto u = 1_p +2;      // OK

Same applies to dot operator following an integer or floating-point user-defined literal:

#include <chrono>
using namespace std::literals;
auto a = 4s.count();   // Error
auto b = 4s .count();  // OK
auto c = (4s).count(); // OK

Otherwise, a single invalid preprocessing number token (e.g., 1.0 _E + 2.0 or 4s. count ) is formed, which causes compilation to fail.

Keywords

operator

Examples

#include <algorithm>
#include <cstddef>
#include <iostream>
#include <numbers>
#include <string>
// used as conversion from degrees (input param) to radians (returned output)
constexpr long double operator""_deg_to_rad(long double deg)
{
    long double radians = deg * std::numbers::pi_v<long double> / 180;
    return radians;
}
// used with custom type
struct mytype
{
    unsigned long long m;
};
constexpr mytype operator""_mytype(unsigned long long n)
{
    return mytype{n};
}
// used for side-effects
void operator""_print(const char* str)
{
    std::cout << str << '\n';
}
#if __cpp_nontype_template_args < 201911
std::string operator""_x2 (const char* str, std::size_t)
{
    return std::string{str} + str;
}
#else // C++20 string literal operator template
template<std::size_t N>
struct DoubleString
{
    char p[N + N - 1]{};
    constexpr DoubleString(char const(&pp)[N])
    {
        std::ranges::copy(pp, p);
        std::ranges::copy(pp, p + N - 1);
    }
};
template<DoubleString A>
constexpr auto operator""_x2()
{
    return A.p;
}
#endif // C++20
int main()
{
    double x_rad = 90.0_deg_to_rad;
    std::cout << std::fixed << x_rad << '\n';
    mytype y = 123_mytype;
    std::cout << y.m << '\n';
    0x123ABC_print;
    std::cout << "abc"_x2 << '\n';
}

1.570796
123
0x123ABC
abcabc

Standard library

The following literal operators are defined in the standard library:

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.