Namespaces
Variants
Views
Actions

std::experimental::ranges::Writable

From cppreference.com
< cpp‎ | experimental‎ | ranges
 
 
Experimental
Technical Specification
Filesystem library (filesystem TS)
Library fundamentals (library fundamentals TS)
Library fundamentals 2 (library fundamentals TS v2)
Library fundamentals 3 (library fundamentals TS v3)
Extensions for parallelism (parallelism TS)
Extensions for parallelism 2 (parallelism TS v2)
Extensions for concurrency (concurrency TS)
Extensions for concurrency 2 (concurrency TS v2)
Concepts (concepts TS)
Ranges (ranges TS)
Reflection (reflection TS)
Mathematical special functions (special functions TR)
Experimental Non-TS
Pattern Matching
Linear Algebra
std::execution
Contracts
2D Graphics
 
 
Iterators library
Iterator concepts
Indirect callable concepts
                                                  
                                                  
                                                  
Common algorithm requirements
                                                  
Concept utilities
Iterator utilities and operations
Iterator traits
Iterator adaptors
Stream iterators
 
template< class Out, class T >

concept bool Writable =
    requires(Out&& o, T&& t) {
        *o = std::forward<T>(t);
        *std::forward<Out>(o) = std::forward<T>(t);
        const_cast<const ranges::reference_t<Out>&&>(*o) =
            std::forward<T>(t);
        const_cast<const ranges::reference_t<Out>&&>(*std::forward<Out>(o)) =
            std::forward<T>(t);
    };

    /* none of the four expressions above are required to be equality-preserving */
(ranges TS)

The concept Writable<Out, T> specifies the requirements for writing a value whose type and value category are encoded by T into an iterator Out's referenced object.

Let E be an expression such that decltype((E)) is T, and o be a dereferenceable object of type Out, then Writable<Out, T> is satisfied only if:

  • If Readable<Out> && Same<ranges::value_type_t<Out>, std::decay_t<T>> is satisfied, then *o after any above assignment is equal to the value of E before the assignment.

o is not required to be dereferenceable after evaluating any of the assignment expressions above. If E is an xvalue, the resulting state of the object it denotes is valid but unspecified.

[edit] 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.

[edit] Notes

The only valid use of operator* is on the left side of an assignment expression. Assignment through the same value of a writable type may happen only once.

The required expressions with const_cast prevent Readable objects with prvalue reference types from satisfying the syntactic requirements of Writable by accident, while permitting proxy references to continue to work as long as their constness is shallow. See Ranges TS issue 381.