forked from boostorg/variant2
Update documentation
This commit is contained in:
@ -1,16 +1,18 @@
|
|||||||
////
|
////
|
||||||
Copyright 2019-2021 Peter Dimov
|
Copyright 2019-2021 Peter Dimov
|
||||||
|
|
||||||
Distributed under the Boost Software License, Version 1.0.
|
Distributed under the Boost Software License, Version 1.0.
|
||||||
|
https://www.boost.org/LICENSE_1_0.txt
|
||||||
See accompanying file LICENSE_1_0.txt or copy at
|
|
||||||
http://www.boost.org/LICENSE_1_0.txt
|
|
||||||
////
|
////
|
||||||
|
|
||||||
[#changelog]
|
[#changelog]
|
||||||
# Revision History
|
# Revision History
|
||||||
:idprefix: changelog_
|
:idprefix: changelog_
|
||||||
|
|
||||||
|
## Changes in 1.78.0
|
||||||
|
|
||||||
|
* Added `<boost/variant2.hpp>`.
|
||||||
|
* Added `unsafe_get<I>`.
|
||||||
|
|
||||||
## Changes in 1.76.0
|
## Changes in 1.76.0
|
||||||
|
|
||||||
* Improved generated code for the double buffered case.
|
* Improved generated code for the double buffered case.
|
||||||
|
@ -1,10 +1,7 @@
|
|||||||
////
|
////
|
||||||
Copyright 2018, 2019 Peter Dimov
|
Copyright 2018-2021 Peter Dimov
|
||||||
|
|
||||||
Distributed under the Boost Software License, Version 1.0.
|
Distributed under the Boost Software License, Version 1.0.
|
||||||
|
https://www.boost.org/LICENSE_1_0.txt
|
||||||
See accompanying file LICENSE_1_0.txt or copy at
|
|
||||||
http://www.boost.org/LICENSE_1_0.txt
|
|
||||||
////
|
////
|
||||||
|
|
||||||
[#reference]
|
[#reference]
|
||||||
@ -117,6 +114,21 @@ template<class U, class... T>
|
|||||||
constexpr add_pointer_t<const U>
|
constexpr add_pointer_t<const U>
|
||||||
get_if(const variant<T...>* v) noexcept;
|
get_if(const variant<T...>* v) noexcept;
|
||||||
|
|
||||||
|
// unsafe_get (extension)
|
||||||
|
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr variant_alternative_t<I, variant<T...>>&
|
||||||
|
unsafe_get(variant<T...>& v);
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr variant_alternative_t<I, variant<T...>>&&
|
||||||
|
unsafe_get(variant<T...>&& v);
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr const variant_alternative_t<I, variant<T...>>&
|
||||||
|
unsafe_get(const variant<T...>& v);
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr const variant_alternative_t<I, variant<T...>>&&
|
||||||
|
unsafe_get(const variant<T...>&& v);
|
||||||
|
|
||||||
// relational operators
|
// relational operators
|
||||||
|
|
||||||
template<class... T>
|
template<class... T>
|
||||||
@ -775,6 +787,34 @@ Requires: :: The type `U` occurs exactly once in `T...`. Otherwise, the
|
|||||||
Effects: :: Equivalent to: `return get_if<I>(v);` with `I` being
|
Effects: :: Equivalent to: `return get_if<I>(v);` with `I` being
|
||||||
the zero-based index of `U` in `T...`.
|
the zero-based index of `U` in `T...`.
|
||||||
|
|
||||||
|
### unsafe_get (extension)
|
||||||
|
|
||||||
|
```
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr variant_alternative_t<I, variant<T...>>&
|
||||||
|
unsafe_get(variant<T...>& v);
|
||||||
|
```
|
||||||
|
```
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr variant_alternative_t<I, variant<T...>>&&
|
||||||
|
unsafe_get(variant<T...>&& v);
|
||||||
|
```
|
||||||
|
```
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr const variant_alternative_t<I, variant<T...>>&
|
||||||
|
unsafe_get(const variant<T...>& v);
|
||||||
|
```
|
||||||
|
```
|
||||||
|
template<size_t I, class... T>
|
||||||
|
constexpr const variant_alternative_t<I, variant<T...>>&&
|
||||||
|
unsafe_get(const variant<T...>&& v);
|
||||||
|
```
|
||||||
|
[none]
|
||||||
|
* {blank}
|
||||||
|
+
|
||||||
|
Requires: :: `v.index() == I`.
|
||||||
|
Returns: :: a reference to the object stored in the variant.
|
||||||
|
|
||||||
### Relational Operators
|
### Relational Operators
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -878,3 +918,7 @@ public:
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## <boost/variant2.hpp>
|
||||||
|
|
||||||
|
This convenience header includes `<boost/variant2/variant.hpp>`.
|
||||||
|
Reference in New Issue
Block a user