boostorg/variant2
1
0
Fork 1
mirror of https://github.com/boostorg/variant2.git synced 2026-01-24 16:12:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Peter Dimov
2026-01-22 02:39:43 +02:00
parent 6e8f4e955d
commit b137164c0d
2 changed files with 12 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/variant2/changelog.adoc
View File

@@ -8,6 +8,10 @@ https://www.boost.org/LICENSE_1_0.txt
# Revision History
:idprefix: changelog_
## Changes in 1.91.0
* `holds_alternative<T>` and `get<T>` have been relaxed to no longer require `T` to occur exactly once in the list of alternatives. It now must occur at least once.
## Changes in 1.90.0
* More functions have been marked as `constexpr`, including `~variant`.

24
doc/variant2/reference.adoc
View File

@@ -719,10 +719,8 @@ template<class U, class... T>
[none]
* {blank}
+
Requires: :: The type `U` occurs exactly once in `T...`. Otherwise, the
program is ill-formed.
Returns: :: `true` if `index()` is equal to the zero-based index of `U`
in `T...`.
Requires: :: The type `U` must be present in `T...`. Otherwise, the program is ill-formed.
Returns: :: `true` if `v` holds a value of type `U`, otherwise `false`.
### get
@@ -773,10 +771,8 @@ template<class U, class... T>
[none]
* {blank}
+
Requires: :: The type `U` occurs exactly once in `T...`. Otherwise, the
program is ill-formed.
Effects: :: If `v` holds a value of type `U`, returns a reference to that value.
Otherwise, throws `bad_variant_access`.
Requires: :: The type `U` must be present in `T...`. Otherwise, the program is ill-formed.
Effects: :: If `v` holds a value of type `U`, returns a reference to that value. Otherwise, throws `bad_variant_access`.
### get_if
@@ -793,10 +789,8 @@ template<size_t I, class... T>
[none]
* {blank}
+
Effects: :: A pointer to the value stored in the variant, if
`v != nullptr && v\->index() == I`. Otherwise, `nullptr`.
Remarks: :: These functions do not participate in overload resolution
unless `I` < `sizeof...(T)`.
Returns: :: A pointer to the value stored in `*v`, if `v != nullptr && v\->index() == I`. Otherwise, `nullptr`.
Remarks: :: These functions do not participate in overload resolution unless `I` < `sizeof...(T)`.
```
template<class U, class... T>
@@ -811,10 +805,8 @@ template<class U, class... T>
[none]
* {blank}
+
Requires: :: The type `U` occurs exactly once in `T...`. Otherwise, the
program is ill-formed.
Effects: :: Equivalent to: `return get_if<I>(v);` with `I` being
the zero-based index of `U` in `T...`.
Requires: :: The type `U` must be present in `T...`. Otherwise, the program is ill-formed.
Returns: :: If `v != nullptr` and `*v` holds a value of type `U`, a pointer to that value. Otherwise, `nullptr`.
### unsafe_get (extension)