blob: ab956f49f916e1ba215c7b9ebcbdc986d6dd627f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
//! [wrapped_type_documentation]
\typealias \1::wrapped_type
The type that is wrapped by this type.
This type is always deprived of qualifiers and is never a pointer
type.
//! [wrapped_type_documentation]
//! [has_equality_operator_documentation]
\variable \1::has_equality_operator_v
True when the wrapped_type can be compared for equality.
When this is the case, \1 can be compared for equality and inequality.
//! [has_equality_operator_documentation]
//! [has_less_than_operator_documentation]
\variable \1::has_less_than_operator_v
True when the wrapped_type can be compared for lesserness.
When this is the case, \1 can be compared for lesserness.
//! [has_less_than_operator_documentation]
//! [has_strictly_less_than_operator_documentation]
\variable \1::has_strictly_less_than_operator_v
True when the wrapped_type can be compared for strict lesserness.
When this is the case, \1 can be compared for strict lesserness.
//! [has_stricly_less_than_operator_documentation]
//! [has_greater_than_operator_documentation]
\variable \1::has_greater_than_operator_v
True when the wrapped_type can be compared for greaterness.
When this is the case, \1 can be compared for greaterness.
//! [has_less_than_operator_documentation]
//! [has_strictly_greater_than_operator_documentation]
\variable \1::has_strictly_greater_than_operator_v
True when the wrapped_type can be compared for strict greaterness.
When this is the case, \1 can be compared for strict greaterness.
//! [has_stricly_greater_than_operator_documentation]
//! [refine_documentation]
\fn static std::optional<\1> \1::refine(wrapped_type value)
Returns an instance of \1 wrapping \a value if \a value respects the
guarantees that are required by \1.
If such is not the case, \c {std::nullopt} is returned instead.
//! [refine_documentation]
//! [value_documentation]
\fn const wrapped_type& \1::value() const noexcept
Returns a const reference to the value that is wrapped by this
instance.
//! [value_documentation]
//! [copy_constructor_documentation]
\fn \1::\1(const \1& other)
Copy-constructs an instance of \1 from \a other.
This constructor is generated by the compiler.
//! [copy_constructor_documentation]
//! [copy_assignment_documentation]
\fn \1::operator=(const \1& other)
Copy-assigns to this instance of \1 from \a other.
This constructor is generated by the compiler.
//! [copy_assignment_documentation]
//! [move_constructor_documentation]
\fn \1::\1(\1&& other)
Move-constructs an instance of \1 from \a other.
The only valid operations on an instance that was moved-from are
destruction and reassignment.
This constructor is generated by the compiler.
//! [move_constructor_documentation]
//! [move_assignment_documentation]
\fn \1::operator=(\1&& other)
Move-assigns to this instance of \1 from \a other.
The only valid operations on an instance that was moved-from are
destruction and reassignment.
This constructor is generated by the compiler.
//! [move_assignment_documentation]
//! [conversion_documentation]
\fn operator wrapped_type() const
Converts this instance to its wrapped value.
//! [conversion_documentation]
//! [operator_equal_documentation]
\fn bool operator=(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance and \a rhs compare
equal.
Returns false otherwise.
//! [operator_equal_documentation]
//! [operator_unequal_documentation]
\fn bool operator!=(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance and \a rhs do not
compare equal.
Returns false otherwise.
//! [operator_unequal_documentation]
//! [operator_less_than_documentation]
\fn bool operator<(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance compares less than
the value wrapped by \a rhs.
Returns false otherwise.
//! [operator_less_than_documentation]
//! [operator_less_than_or_equal_documentation]
\fn bool operator<=(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance compares less than
or equal than the value wrapped by \a rhs.
Returns false otherwise.
//! [operator_less_than_or_equal_documentation]
//! [operator_greater_than_documentation]
\fn bool operator>(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance compares greater
than the value wrapped by \a rhs.
Returns false otherwise.
//! [operator_greater_than_documentation]
//! [operator_greater_than_or_equal_documentation]
\fn bool operator>=(const \1& rhs) const noexcept
Returns true if the value wrapped by this instance compares greater
than or equal or equal than the value wrapped by \a rhs.
Returns false otherwise.
//! [operator_greater_than_or_equal_documentation]
|
