Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/named req/ValueSwappable"

From cppreference.com
< cpp‎ | named req
m (Text replace - "{{concept" to "{{named req")
m (fmt, .)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{cpp/named req/title|ValueSwappable}}
+
{{cpp/named req/title|ValueSwappable|notes={{mark since c++11}}}}
 
{{cpp/named req/navbar}}
 
{{cpp/named req/navbar}}
 
Two objects of this type can be dereferenced and the resulting values can be swapped using unqualified function call {{c|swap()}} in the context where both {{lc|std::swap}} and the user-defined {{c|swap()}}s are visible.
 
Two objects of this type can be dereferenced and the resulting values can be swapped using unqualified function call {{c|swap()}} in the context where both {{lc|std::swap}} and the user-defined {{c|swap()}}s are visible.
  
 
===Requirements===
 
===Requirements===
 +
A type T is {{named req/core|ValueSwappable}} if
  
Type T is {{named req|ValueSwappable}} if
+
# {{tt|T}} satisfies the {{named req|Iterator}} requirements.
 +
# For any dereferenceable object {{tt|x}} of type {{tt|T}} (that is, any value other than the end iterator), {{tt|*x}} satisfies the {{named req|Swappable}} requirements.
  
@1@ Type {{tt|T}} satisfies the {{named req|Iterator}} requirements
+
Many standard library functions expect their arguments to satisfy {{named req/core|ValueSwappable}}, which means that any time the standard library performs a swap, it uses the equivalent of {{c|using std::swap; swap(*iter1, *iter2);}}.
@2@ For any dereferencable object {{tt|x}} of type {{tt|T}} (that is, any value other than the end iterator), {{tt|*x}} satisfies the {{named req|Swappable}} requirements.
+
 
+
Many standard library functions expect their arguments to satisfy {{named req|ValueSwappable}}, which means that any time the standard library performs a swap, it uses the equivalent of {{c|using std::swap; swap(*iter1, *iter2);}}.
+
  
 
===Example===
 
===Example===
 
{{example
 
{{example
|
+
|code=
| code=
+
 
+
 
#include <iostream>
 
#include <iostream>
 
#include <vector>
 
#include <vector>
  
class IntVector {
+
class IntVector
 +
{
 
     std::vector<int> v;
 
     std::vector<int> v;
    IntVector& operator=(IntVector); // not assignable
+
//  IntVector& operator=(IntVector); // not assignable (C++98 way)
public:
+
public:
     void swap(IntVector& other) {
+
    IntVector& operator=(IntVector) = delete; // not assignable
 +
     void swap(IntVector& other)
 +
    {
 
         v.swap(other.v);
 
         v.swap(other.v);
 
     }
 
     }
 
};
 
};
void swap(IntVector& v1, IntVector& v2) {
+
 
 +
void swap(IntVector& v1, IntVector& v2)
 +
{
 
     v1.swap(v2);
 
     v1.swap(v2);
 
}
 
}
Line 42: Line 44:
 
}}
 
}}
  
[[de:cpp/named req/ValueSwappable]]
+
===See also===
[[es:cpp/named req/ValueSwappable]]
+
{{dsc begin}}
[[fr:cpp/named req/ValueSwappable]]
+
{{dsc inc|cpp/iterator/dsc indirectly_swappable}}
[[it:cpp/named req/ValueSwappable]]
+
{{dsc end}}
[[ja:cpp/named req/ValueSwappable]]
+
 
[[pt:cpp/named req/ValueSwappable]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
[[ru:cpp/named req/ValueSwappable]]
+
[[zh:cpp/named req/ValueSwappable]]
+

Latest revision as of 03:11, 9 August 2023

 
 
C++ named requirements
 

Two objects of this type can be dereferenced and the resulting values can be swapped using unqualified function call swap() in the context where both std::swap and the user-defined swap()s are visible.

[edit] Requirements

A type T is ValueSwappable if

  1. T satisfies the LegacyIterator requirements.
  2. For any dereferenceable object x of type T (that is, any value other than the end iterator), *x satisfies the Swappable requirements.

Many standard library functions expect their arguments to satisfy ValueSwappable, which means that any time the standard library performs a swap, it uses the equivalent of using std::swap; swap(*iter1, *iter2);.

[edit] Example

#include <iostream>
#include <vector>
 
class IntVector
{
    std::vector<int> v;
//  IntVector& operator=(IntVector); // not assignable (C++98 way)
public:
    IntVector& operator=(IntVector) = delete; // not assignable
    void swap(IntVector& other)
    {
        v.swap(other.v);
    }
};
 
void swap(IntVector& v1, IntVector& v2)
{
    v1.swap(v2);
}
 
int main()
{
    IntVector v1, v2;    // IntVector is Swappable, but not MoveAssignable
    IntVector* p1 = &v1;
    IntVector* p2 = &v2; // IntVector* is ValueSwappable
    std::iter_swap(p1, p2); // OK: iter_swap requires ValueSwappable
//  std::swap(v1, v2); // compiler error! std::swap requires MoveAssignable
}

[edit] See also

specifies that the values referenced by two indirectly_readable types can be swapped
(concept) [edit]