std::Invocable, std::RegularInvocable

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Concepts library

Core language concepts
Same DerivedFrom ConvertibleTo CommonReference Common	Integral SignedIntegral UnsignedIntegral Assignable SwappableSwappableWith	Destructible Constructible DefaultConstructible MoveConstructible CopyConstructible
Comparison concepts
Boolean	EqualityComparableEqualityComparableWith	StrictTotallyOrderedStrictTotallyOrderedWith
Object concepts
Movable Copyable	Semiregular Regular
Callable concepts
InvocableRegularInvocable	Predicate	Relation StrictWeakOrder

 

Defined in header <concepts>
template< class F, class... Args > concept Invocable =   requires(F&& f, Args&&... args) {     std::invoke(std::forward<F>(f), std::forward<Args>(args)...);       /* not required to be equality preserving */   };		(since C++20)
template< class F, class... Args > concept RegularInvocable = std::Invocable<F, Args...>;		(since C++20)

The Invocable concept specifies that a callable type F can be called with a set of argument types Args... using the function template std::invoke.

The RegularInvocable concept adds to the Invocable concept by requiring the invoke expression to be equality preserving and not modify either the function object or the arguments.

Equality preservation

An expression is equality preserving if it results in equal outputs given equal inputs.

• The inputs to an expression consist of its operands.
• The outputs of an expression consist of its result and all operands modified by the expression (if any).

Every expression required to be equality preserving is further required to be stable: two evaluations of such an expression with the same input objects must have equal outputs absent any explicit intervening modification of those input objects.

Unless noted otherwise, every expression used in a requires-expression is required to be equality preserving and stable, and the evaluation of the expression may only modify its non-constant operands. Operands that are constant must not be modified.

Notes

The distinction between Invocable and RegularInvocable is purely semantic.

A random number generator may satisfy Invocable but cannot satisfy RegularInvocable (comical ones excluded).