Namespaces
Variants
Views
Actions

C++ attribute: assume (since C++23)

From cppreference.com
< cpp‎ | language‎ | attributes
 
 
C++ language
General topics
Flow control
Conditional execution statements
if
Iteration statements (loops)
for
range-for (C++11)
Jump statements
Functions
Function declaration
Lambda function expression
inline specifier
Dynamic exception specifications (until C++17*)
noexcept specifier (C++11)
Exceptions
Namespaces
Types
Specifiers
const/volatile
decltype (C++11)
auto (C++11)
constexpr (C++11)
consteval (C++20)
constinit (C++20)
Storage duration specifiers
Initialization
Expressions
Alternative representations
Literals
Boolean - Integer - Floating-point
Character - String - nullptr (C++11)
User-defined (C++11)
Utilities
Attributes (C++11)
Types
typedef declaration
Type alias declaration (C++11)
Casts
Memory allocation
Classes
Class-specific function properties
explicit (C++11)
static

Special member functions
Templates
Miscellaneous
 
 
Attributes
assume
(C++23)
(C++14)
(C++20)
(C++17)
(C++11)
(C++20)
 

Specifies that the given expression is assumed to always evaluate to true at a given point. The behavior is undefined if the assumption does not hold.

Contents

[edit] Syntax

[[assume( expression )]]
expression - an expression contextually converted to bool where expression that must evaluate to true

[edit] Explanation

The expression may not be a comma operator expression, but enclosing the expression in parentheses will allow the comma operator to be used.

The expression is not evaluated (but it is still potentially evaluated).

Can only be applied to a null statement, as in [[assume(x > 0)]];. This statement is called an assumption. If the expression would not evaluate to true at the place the assumption occurs, the behavior is undefined. Otherwise, the statement has no effect.

The purpose of an assumption is to allow compiler optimizations based on the information given.

[edit] Notes

Since assumptions cause undefined behavior if they do not hold, they should be used sparingly.

One correct way to use them is to follow assertions with assumptions:

assert(x > 0);     // trigger an assertion when NDEBUG is not defined and x > 0 is false
[[assume(x > 0)]]; // provide optimization opportunities when NDEBUG is defined

[edit] Example

#include <cmath>
 
void f(int& x, int y)
{
    void g(int);
    void h();
 
    [[assume(x > 0)]]; // Compiler may assume x is positive
 
    g(x / 2); // More efficient code possibly generated
 
    x = 3;
    int z = x;
 
    [[assume((h(), x == z))]]; // Compiler may assume x would have the same value after
                               // calling h
                               // The assumption does not cause a call to h
 
    h();
    g(x); // Compiler may replace this with g(3);
 
    h();
    g(x); // Compiler may NOT replace this with g(3);
          // An assumption applies only at the point where it appears
 
    z = std::abs(y);
 
    [[assume((g(z), true))]]; // Compiler may assume g(z) will return
 
    g(z); // Due to above and below assumptions, compiler may replace this with g(10);
 
    [[assume(y == -10)]]; // Undefined behavior if y != -10 at this point
 
    [[assume((x - 1) * 3 == 12)]];
 
    g(x); // Compiler may replace this with g(5);
}

[edit] References

  • C++23 standard (ISO/IEC 14882:2024):
  • 9.12.3 Assumption attribute [dcl.attr.assume]

[edit] See also

marks unreachable point of execution
(function) [edit]

[edit] External links

1.  Clang language extensions doc: __builtin_assume.
2.  Clang attribute reference doc: assume.
3.  MSVC doc: __assume built-in.
4.  GCC doc: __attribute__((assume(...))).