16 Library introduction [library]

16.3 Method of description [description]

16.3.2 Structure of each clause [structure]

16.3.2.4 Detailed specifications [structure.specifications]

1
#
The detailed specifications each contain the following elements:
  • (1.1)
    name and brief description
  • (1.2)
    synopsis (class definition or function declaration, as appropriate)
  • (1.3)
    restrictions on template arguments, if any
  • (1.4)
    description of class invariants
  • (1.5)
    description of function semantics
2
#
Descriptions of class member functions follow the order (as appropriate):136
  • (2.1)
    constructor(s) and destructor
  • (2.2)
    copying, moving & assignment functions
  • (2.3)
    comparison operator functions
  • (2.4)
    modifier functions
  • (2.5)
    observer functions
  • (2.6)
    operators and other non-member functions
3
#
Descriptions of function semantics contain the following elements (as appropriate):137
  • (3.1)
    Constraints: the conditions for the function's participation in overload resolution ([over.match]).
    [Note 1: 
    Failure to meet such a condition results in the function's silent non-viability.
    — end note]
    [Example 1: 
    An implementation can express such a condition via a constraint-expression ([temp.constr.decl]).
    — end example]
  • (3.2)
    Mandates: the conditions that, if not met, render the program ill-formed.
    [Example 2: 
    An implementation can express such a condition via the constant-expression in a static_assert-declaration ([dcl.pre]).
    If the diagnostic is to be emitted only after the function has been selected by overload resolution, an implementation can express such a condition via a constraint-expression ([temp.constr.decl]) and also define the function as deleted.
    — end example]
  • (3.3)
    Preconditions: the conditions that the function assumes to hold whenever it is called; violation of any preconditions results in undefined behavior.
  • (3.4)
    Effects: the actions performed by the function.
  • (3.5)
    Synchronization: the synchronization operations ([intro.multithread]) applicable to the function.
  • (3.6)
    Postconditions: the conditions (sometimes termed observable results) established by the function.
  • (3.7)
    Result: for a typename-specifier, a description of the named type; for an expression, a description of the type and value category of the expression; the expression is an lvalue if the type is an lvalue reference type, an xvalue if the type is an rvalue reference type, and a prvalue otherwise.
  • (3.8)
    Returns: a description of the value(s) returned by the function.
  • (3.9)
    Throws: any exceptions thrown by the function, and the conditions that would cause the exception.
  • (3.10)
    Complexity: the time and/or space complexity of the function.
  • (3.11)
    Remarks: additional semantic constraints on the function.
  • (3.12)
    Error conditions: the error conditions for error codes reported by the function.
4
#
Whenever the Effects element specifies that the semantics of some function F are Equivalent to some code sequence, then the various elements are interpreted as follows.
If F's semantics specifies any Constraints or Mandates elements, then those requirements are logically imposed prior to the equivalent-to semantics.
Next, the semantics of the code sequence are determined by the Constraints, Mandates, Preconditions, Effects, Synchronization, Postconditions, Returns, Throws, Complexity, Remarks, and Error conditions specified for the function invocations contained in the code sequence.
The value returned from F is specified by F's Returns element, or if F has no Returns element, a non-void return from F is specified by the return statements ([stmt.return]) in the code sequence.
If F's semantics contains a Throws, Postconditions, or Complexity element, then that supersedes any occurrences of that element in the code sequence.
5
#
For non-reserved replacement and handler functions, [support] specifies two behaviors for the functions in question: their required and default behavior.
The default behavior describes a function definition provided by the implementation.
The required behavior describes the semantics of a function definition provided by either the implementation or a C++ program.
Where no distinction is explicitly made in the description, the behavior described is the required behavior.
6
#
If the formulation of a complexity requirement calls for a negative number of operations, the actual requirement is zero operations.138
7
#
Complexity requirements specified in the library clauses are upper bounds, and implementations that provide better complexity guarantees meet the requirements.
8
#
Error conditions specify conditions where a function may fail.
The conditions are listed, together with a suitable explanation, as the enum class errc constants ([syserr]).
136)136)
To save space, items that do not apply to a class are omitted.
For example, if a class does not specify any comparison operator functions, there will be no “Comparison operator functions” subclause.
137)137)
To save space, elements that do not apply to a function are omitted.
For example, if a function specifies no preconditions, there will be no Preconditions: element.
138)138)
This simplifies the presentation of complexity requirements in some cases.