boostorg/variant2
1
0
Fork 1
mirror of https://github.com/boostorg/variant2.git synced 2025-07-29 11:47:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Apply corrections from #10. Closes #10.

Browse Source
This commit is contained in:
Peter Dimov
2019-05-12 19:19:55 +03:00
parent e686dab3ea
commit a083667a96
2 changed files with 28 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/html/variant2.html
View File

@ -1103,6 +1103,10 @@ public:
} // namespace boost</code></pre>
</div>
</div>
<div class="paragraph">
<p>In the descriptions that follow, let <code>i</code> be in the range <code>[0, sizeof&#8230;&#8203;(T))</code>,
and <code>Ti</code> be the <code>i</code>-th type in <code>T&#8230;&#8203;</code>.</p>
</div>
<div class="sect4">
<h5 id="ref_constructors">Constructors</h5>
<div class="listingblock">
@ -2129,6 +2133,11 @@ in <code>T&#8230;&#8203;</code>.</p>
<p>If <code>v.index()</code> is <code>I</code>, returns a reference to the object stored in
the variant. Otherwise, throws <code>bad_variant_access</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>These functions do not participate in overload resolution
unless <code>I</code> &lt; <code>sizeof&#8230;&#8203;(T)</code>.</p>
</dd>
</dl>
</div>
</li>
@ -2202,15 +2211,16 @@ Otherwise, throws <code>bad_variant_access</code>.</p>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Requires: </dt>
<dd>
<p><code>I &lt; sizeof&#8230;&#8203;(U)</code>. Otherwise, the program is ill-formed.</p>
</dd>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>A pointer to the value stored in the variant, if
<code>v != nullptr &amp;&amp; v-&gt;index() == I</code>. Otherwise, <code>nullptr</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>These functions do not participate in overload resolution
unless <code>I</code> &lt; <code>sizeof&#8230;&#8203;(T)</code>.</p>
</dd>
</dl>
</div>
</li>
@ -2268,7 +2278,7 @@ the zero-based index of <code>U</code> in <code>T&#8230;&#8203;</code>.</p>
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>v.index() == w.index &amp;&amp; get&lt;I&gt;(v) == get&lt;I&gt;(w)</code>, where <code>I</code>
<p><code>v.index() == w.index() &amp;&amp; get&lt;I&gt;(v) == get&lt;I&gt;(w)</code>, where <code>I</code>
is <code>v.index()</code>.</p>
</dd>
</dl>
@ -2311,7 +2321,7 @@ is <code>v.index()</code>.</p>
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>v.index() &lt; w.index || (v.index() == w.index &amp;&amp; get&lt;I&gt;(v) &lt; get&lt;I&gt;(w))</code>,
<p><code>v.index() &lt; w.index() || (v.index() == w.index() &amp;&amp; get&lt;I&gt;(v) &lt; get&lt;I&gt;(w))</code>,
where <code>I</code> is <code>v.index()</code>.</p>
</dd>
</dl>
@ -2354,7 +2364,7 @@ where <code>I</code> is <code>v.index()</code>.</p>
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>v.index() &lt; w.index || (v.index() == w.index &amp;&amp; get&lt;I&gt;(v) &lt;= get&lt;I&gt;(w))</code>,
<p><code>v.index() &lt; w.index() || (v.index() == w.index() &amp;&amp; get&lt;I&gt;(v) &lt;= get&lt;I&gt;(w))</code>,
where <code>I</code> is <code>v.index()</code>.</p>
</dd>
</dl>
@ -2466,7 +2476,7 @@ the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Versi
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-05-12 00:15:41 +0300
Last updated 2019-05-12 18:44:13 +0300
</div>
</div>
<style>

14
doc/variant2/reference.adoc
View File

@ -247,6 +247,9 @@ public:
} // namespace boost
```
In the descriptions that follow, let `i` be in the range `[0, sizeof...(T))`,
and `Ti` be the `i`-th type in `T...`.
#### Constructors
```
@ -707,6 +710,8 @@ template<size_t I, class... T>
+
Effects: :: If `v.index()` is `I`, returns a reference to the object stored in
the variant. Otherwise, throws `bad_variant_access`.
Remarks: :: These functions do not participate in overload resolution
unless `I` < `sizeof...(T)`.
```
template<class U, class... T>
@ -747,9 +752,10 @@ template<size_t I, class... T>
[none]
* {blank}
+
Requires: :: `I < sizeof...(U)`. Otherwise, the program is ill-formed.
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)`.
```
template<class U, class... T>
@ -778,7 +784,7 @@ template<class... T>
[none]
* {blank}
+
Returns: :: `v.index() == w.index && get<I>(v) == get<I>(w)`, where `I`
Returns: :: `v.index() == w.index() && get<I>(v) == get<I>(w)`, where `I`
is `v.index()`.
```
@ -797,7 +803,7 @@ template<class... T>
[none]
* {blank}
+
Returns: :: `v.index() < w.index || (v.index() == w.index && get<I>(v) < get<I>(w))`,
Returns: :: `v.index() < w.index() || (v.index() == w.index() && get<I>(v) < get<I>(w))`,
where `I` is `v.index()`.
```
@ -816,7 +822,7 @@ template<class... T>
[none]
* {blank}
+
Returns: :: `v.index() < w.index || (v.index() == w.index && get<I>(v) \<= get<I>(w))`,
Returns: :: `v.index() < w.index() || (v.index() == w.index() && get<I>(v) \<= get<I>(w))`,
where `I` is `v.index()`.
```