Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/named req"

From cppreference.com
< cpp
m (implictly -> implicitly, an LegacyIterator -> a LegacyIterator)
(+ BooleanTestable)
 
(4 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
The ''named requirements'' listed on this page are the named requirements used in the normative text of the C++ standard to define the expectations of the standard library.
 
The ''named requirements'' listed on this page are the named requirements used in the normative text of the C++ standard to define the expectations of the standard library.
  
−
Some of these requirements are being formalized in C++20 using the [[cpp/language/constraints|concepts]] language feature. Until then, the burden is on the programmer to ensure that library templates are instantiated with template arguments that satisfy these requirements. Failure to do so may result in very complex compiler diagnostics.
+
The burden to ensure that library templates are instantiated with template arguments that satisfy these requirements is on the programmer. Failure to do so may result in very complex compiler diagnostics.
 +
 
 +
Some of these requirements are formalized in C++20 using the [[cpp/language/constraints|concepts]] language feature.
  
 
{{dsc begin}}
 
{{dsc begin}}
Line 25: Line 27:
  
 
{{dsc h1|Library-wide}}
 
{{dsc h1|Library-wide}}
 +
{{dsc named req|cpp/named req/BooleanTestable<!-- LWG2114, P2167R3 -->|boolean operations ({{c/core|operator&&}}, {{c/core|operator{{!!}}}}, and {{c/core|operator!}}) have usual semantics}}
 
{{dsc named req|cpp/named req/EqualityComparable|{{tt|operator{{==}}}} is an equivalence relation}}
 
{{dsc named req|cpp/named req/EqualityComparable|{{tt|operator{{==}}}} is an equivalence relation}}
 
{{dsc named req|cpp/named req/LessThanComparable|{{tt|operator<}} is a strict weak ordering relation}}
 
{{dsc named req|cpp/named req/LessThanComparable|{{tt|operator<}} is a strict weak ordering relation}}
Line 38: Line 41:
 
{{dsc named req|cpp/named req/Compare|a {{named req|BinaryPredicate}} that establishes an ordering relation}}
 
{{dsc named req|cpp/named req/Compare|a {{named req|BinaryPredicate}} that establishes an ordering relation}}
 
{{dsc end}}
 
{{dsc end}}
 +
 
{{dsc begin}}
 
{{dsc begin}}
 
{{dsc h1|Container}}
 
{{dsc h1|Container}}
Line 65: Line 69:
  
 
{{dsc h1|Stream I/O functions}}
 
{{dsc h1|Stream I/O functions}}
−
<!-- 27.7.2.3[istream.unformatted]/1 -->
+
<!--27.7.2.3[istream.unformatted]/1-->
 
{{dsc named req|cpp/named req/UnformattedInputFunction|a stream input function that does not skip leading whitespace and counts the processed characters}}
 
{{dsc named req|cpp/named req/UnformattedInputFunction|a stream input function that does not skip leading whitespace and counts the processed characters}}
−
<!-- 27.7.2.2.1[istream.formatted.reqmts] -->
+
<!--27.7.2.2.1[istream.formatted.reqmts]-->
 
{{dsc named req|cpp/named req/FormattedInputFunction|a stream input function that skips leading whitespace}}
 
{{dsc named req|cpp/named req/FormattedInputFunction|a stream input function that skips leading whitespace}}
−
<!-- 27.7.3.7[ostream.unformatted]/1 -->
+
<!--27.7.3.7[ostream.unformatted]/1-->
 
{{dsc named req|cpp/named req/UnformattedOutputFunction|a basic stream output function}}
 
{{dsc named req|cpp/named req/UnformattedOutputFunction|a basic stream output function}}
−
<!-- 27.7.3.6.1[ostream.formatted.reqmts] -->
+
<!--27.7.3.6.1[ostream.formatted.reqmts]-->
 
{{dsc named req|cpp/named req/FormattedOutputFunction|a stream output function that sets failbit on errors and returns a reference to the stream}}
 
{{dsc named req|cpp/named req/FormattedOutputFunction|a stream output function that sets failbit on errors and returns a reference to the stream}}
  
Line 89: Line 93:
 
{{dsc named req|cpp/named req/Lockable|a {{named req|BasicLockable}} that supports attempted lock acquisition|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/Lockable|a {{named req|BasicLockable}} that supports attempted lock acquisition|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/TimedLockable|a {{named req|Lockable}} that supports timed lock acquisition|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/TimedLockable|a {{named req|Lockable}} that supports timed lock acquisition|notes={{mark c++11}}}}
−
{{dsc named req|cpp/named req/SharedLockable|provides shared ownership semantics for execution agents (i.e. threads)|notes={{mark c++14}}<!-- P2160R1 -->}}
+
{{dsc named req|cpp/named req/SharedLockable|provides shared ownership semantics for execution agents (i.e. threads)|notes={{mark c++14}}<!--P2160R1-->}}
−
{{dsc named req|cpp/named req/SharedTimedLockable|a {{named req|SharedLockable}} that supports timed lock acquisition|notes={{mark c++14}}<!-- P2160R1 -->}}
+
{{dsc named req|cpp/named req/SharedTimedLockable|a {{named req|SharedLockable}} that supports timed lock acquisition|notes={{mark c++14}}<!--P2160R1-->}}
 
{{dsc named req|cpp/named req/Mutex|a {{named req|Lockable}} that protects against data races and sequentially consistent synchronization|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/Mutex|a {{named req|Lockable}} that protects against data races and sequentially consistent synchronization|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/TimedMutex|a {{named req|TimedLockable}} that protects against data races and sequentially consistent synchronization|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/TimedMutex|a {{named req|TimedLockable}} that protects against data races and sequentially consistent synchronization|notes={{mark c++11}}}}
Line 97: Line 101:
  
 
{{dsc h1|Ranges}}
 
{{dsc h1|Ranges}}
−
{{dsc named req|cpp/named req/RangeAdaptorObject|describes properties of a {{rlp|ranges#Range adaptor objects|range adaptor object}}|notes={{mark c++20}}}}
+
{{dsc named req|cpp/named req/RangeAdaptorObject|a {{named req|FunctionObject}} that creates a [[cpp/ranges#Range adaptors|range adaptor]] from a {{lconcept|viewable_range}} and additional arguments|notes={{mark c++20}}}}
−
{{dsc named req|cpp/named req/RangeAdaptorClosureObject|describes properties of a {{rlp|ranges#Range adaptor closure objects|range adaptor closure object}}|notes={{mark c++20}}}}
+
{{dsc named req|cpp/named req/RangeAdaptorClosureObject|a {{named req|FunctionObject}} that supports the pipe operator|notes={{mark c++20}}}}
 +
 
 +
{{dsc h1|Multidimensional View Customization}}
 +
{{dsc named req|cpp/named req/LayoutMapping|controls the mapping of multidimensional index in {{lc|mdspan}}|notes={{mark c++23}}}}
 +
{{dsc named req|cpp/named req/LayoutMappingPolicy|a policy that holds {{named req|LayoutMapping}} requirements|notes={{mark c++23}}}}
 +
{{dsc named req|cpp/named req/AccessorPolicy|a policy that controls access to data handle in {{lc|mdspan}}|notes={{mark c++23}}}}
  
 
{{dsc h1|Other}}
 
{{dsc h1|Other}}
Line 107: Line 116:
 
{{dsc named req|cpp/named req/TrivialClock|a {{named req|Clock}} that does not throw exceptions|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/TrivialClock|a {{named req|Clock}} that does not throw exceptions|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/CharTraits|defines types and functions for a character type}}
 
{{dsc named req|cpp/named req/CharTraits|defines types and functions for a character type}}
−
{{dsc named req|cpp/named req/BitmaskType|bitset, integer, or enumeration}} <!-- $17.5.2.1.3[bitmask types] -->
+
{{dsc named req|cpp/named req/BitmaskType|bitset, integer, or enumeration}}<!--$17.5.2.1.3[bitmask types]-->
−
{{dsc named req|cpp/named req/NumericType|a type for which initialization is effectively equal to assignment}} <!-- C++98/03 §26.1[lib.numeric.requirements], C++11/14 §26.2[numeric.requirements] -->
+
{{dsc named req|cpp/named req/NumericType|a type for which initialization is effectively equal to assignment}}<!--C++98/03 §26.1[lib.numeric.requirements], C++11/14 §26.2[numeric.requirements]-->
−
{{dsc named req|cpp/named req/RegexTraits|defines types and functions used by the [[cpp/regex|regular expressions library]]|notes={{mark c++11}}}} <!-- C++11/14 §28.3[re.req] -->
+
{{dsc named req|cpp/named req/RegexTraits|defines types and functions used by the [[cpp/regex|regular expressions library]]|notes={{mark c++11}}}}<!--C++11/14 §28.3[re.req]-->
 
{{dsc named req|cpp/named req/LiteralType|a type with constexpr constructor|notes={{mark c++11}}}}
 
{{dsc named req|cpp/named req/LiteralType|a type with constexpr constructor|notes={{mark c++11}}}}
−
 
 
{{dsc end}}
 
{{dsc end}}
−
 
  
 
{{todo|Any other missing requirement?}}
 
{{todo|Any other missing requirement?}}
  
 
{{langlinks|ar|de|es|fr|it|ja|pt|ru|zh}}
 
{{langlinks|ar|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 22:51, 7 September 2024

 
C++
 
C++ named requirements
 

The named requirements listed on this page are the named requirements used in the normative text of the C++ standard to define the expectations of the standard library.

The burden to ensure that library templates are instantiated with template arguments that satisfy these requirements is on the programmer. Failure to do so may result in very complex compiler diagnostics.

Some of these requirements are formalized in C++20 using the concepts language feature.

Contents

Basic

 specifies that an object of the type can be default constructed
(named requirement)
(C++11)
 specifies that an object of the type can be constructed from rvalue
(named requirement)
specifies that an object of the type can be constructed from lvalue
(named requirement)
(C++11)
 specifies that an object of the type can be assigned from rvalue
(named requirement)
specifies that an object of the type can be assigned from lvalue
(named requirement)
specifies that an object of the type can be destroyed
(named requirement)

Type properties

Note: the standard does not define named requirements with names specified in this subcategory.
These are type categories defined by the core language. They are included here as named requirements only for consistency.
object types that are not array types or class types
(named requirement)
(deprecated in C++20)
 POD (Plain Old Data) types, compatible with C struct
(named requirement)
(C++11)
 objects of these types can maintain their values after copying their underlying bytes
(named requirement)
(C++11)
 objects of these types can be trivially constructed and copied
(named requirement)
(C++11)
 these types are useful for communicating with code written in other programming languages
(named requirement)
objects of these types can be implicitly created, and their lifetimes can be implicitly started
(named requirement)

Library-wide

 boolean operations (operator&&, operator||, and operator!) have usual semantics
(named requirement)
operator== is an equivalence relation
(named requirement)
operator< is a strict weak ordering relation
(named requirement)
can be swapped with an unqualified non-member function call swap()
(named requirement)
(C++11)
 a LegacyIterator that dereferences to a Swappable type
(named requirement)
(C++11)
 a pointer-like type supporting a null value
(named requirement)
(C++11)
 a FunctionObject that for inputs with different values has a low probability of giving the same output
(named requirement)
a class type that contains allocation information
(named requirement)
an object that can be called with the function call syntax
(named requirement)
a type for which the invoke operation is defined
(named requirement)
a FunctionObject that returns a value convertible to bool for one argument without modifying it
(named requirement)
a FunctionObject that returns a value convertible to bool for two arguments without modifying them
(named requirement)
a BinaryPredicate that establishes an ordering relation
(named requirement)

Container

 data structure that allows element access using iterators
(named requirement)
container using bidirectional iterators
(named requirement)
(C++11)
 container using an allocator
(named requirement)
container with elements stored linearly
(named requirement)
(C++17)
 container with elements stored at adjacent memory addresses
(named requirement)
container that stores elements by associating them to keys
(named requirement)
(C++11)
 container that stores elements stored in buckets by associating them to keys
(named requirement)
Container element
(C++11)
 element can be default-constructed in uninitialized storage
(named requirement)
(C++11)
 element can be copy-constructed in uninitialized storage
(named requirement)
(C++11)
 element can be move-constructed in uninitialized storage
(named requirement)
(C++11)
 element can be constructed in uninitialized storage
(named requirement)
(C++11)
 element can be destroyed using an allocator
(named requirement)

Iterator

 general concept to access data within some data structure
(named requirement)
iterator that can be used to read data
(named requirement)
iterator that can be used to write data
(named requirement)
iterator that can be used to read data multiple times
(named requirement)
iterator that can be both incremented and decremented
(named requirement)
iterator that can be advanced in constant time
(named requirement)
(C++17)
 iterator to contiguously-allocated elements
(named requirement)
(C++20)
 iterator that can be used during constant expression evaluation
(named requirement)

Stream I/O functions

 a stream input function that does not skip leading whitespace and counts the processed characters
(named requirement)
a stream input function that skips leading whitespace
(named requirement)
a basic stream output function
(named requirement)
a stream output function that sets failbit on errors and returns a reference to the stream
(named requirement)

Formatters

(C++20)
 abstracts formatting operations for a given formatting argument type and character type
(named requirement)
(C++20)
 defines functions used by the formatting library
(named requirement)

Random Number Generation

(C++11)
 consumes a sequence of integers and produces a sequence of 32-bit unsigned values
(named requirement)
(C++11)
 returns uniformly distributed random unsigned integers
(named requirement)
(C++11)
 a deterministic UniformRandomBitGenerator, defined by the seed
(named requirement)
(C++11)
 a RandomNumberEngine that transforms the output of another RandomNumberEngine
(named requirement)
(C++11)
 returns random numbers distributed according to a given mathematical probability density function
(named requirement)

Concurrency

(C++11)
 provides exclusive ownership semantics for execution agents (i.e. threads)
(named requirement)
(C++11)
 a BasicLockable that supports attempted lock acquisition
(named requirement)
(C++11)
 a Lockable that supports timed lock acquisition
(named requirement)
(C++14)
 provides shared ownership semantics for execution agents (i.e. threads)
(named requirement)
(C++14)
 a SharedLockable that supports timed lock acquisition
(named requirement)
(C++11)
 a Lockable that protects against data races and sequentially consistent synchronization
(named requirement)
(C++11)
 a TimedLockable that protects against data races and sequentially consistent synchronization
(named requirement)
(C++17)
 a Mutex that supports shared ownership semantics
(named requirement)
(C++14)
 a TimedMutex that supports shared ownership semantics
(named requirement)

Ranges

(C++20)
 a FunctionObject that creates a range adaptor from a viewable_range and additional arguments
(named requirement)
(C++20)
 a FunctionObject that supports the pipe operator
(named requirement)

Multidimensional View Customization

(C++23)
 controls the mapping of multidimensional index in mdspan
(named requirement)
(C++23)
 a policy that holds LayoutMapping requirements
(named requirement)
(C++23)
 a policy that controls access to data handle in mdspan
(named requirement)

Other

(C++11)
 describes a property of a type
(named requirement)
(C++11)
 describes a relationship between two types
(named requirement)
(C++11)
 modifies a property of a type
(named requirement)
(C++11)
 aggregates a duration, a time point, and a function to get the current time point
(named requirement)
(C++11)
 a Clock that does not throw exceptions
(named requirement)
defines types and functions for a character type
(named requirement)
bitset, integer, or enumeration
(named requirement)
a type for which initialization is effectively equal to assignment
(named requirement)
(C++11)
 defines types and functions used by the regular expressions library
(named requirement)
(C++11)
 a type with constexpr constructor
(named requirement)
This section is incomplete
Reason: Any other missing requirement?
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/named_req&oldid=175887"