detailed_semantics.html 239 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Detailed Semantics</title>
  5. <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  7. <link rel="home" href="../../../index.html" title="Boost.Optional">
  8. <link rel="up" href="../../../optional/reference/header__boost_optional_optional_hpp_.html" title="Header &lt;boost/optional/optional.hpp&gt;">
  9. <link rel="prev" href="header_optional_optional_refs.html" title="Optional References">
  10. <link rel="next" href="header__boost_optional_hpp_.html" title="Header &lt;boost/optional.hpp&gt;">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="header_optional_optional_refs.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../optional/reference/header__boost_optional_optional_hpp_.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="header__boost_optional_hpp_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  27. <a name="boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics"></a><a class="link" href="detailed_semantics.html" title="Detailed Semantics">Detailed
  28. Semantics</a>
  29. </h4></div></div></div>
  30. <p>
  31. Because <code class="computeroutput"><span class="identifier">T</span></code> might be of reference
  32. type, in the sequel, those entries whose semantic depends on <code class="computeroutput"><span class="identifier">T</span></code> being of reference type or not will
  33. be distinguished using the following convention:
  34. </p>
  35. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  36. <li class="listitem">
  37. If the entry reads: <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code><span class="emphasis"><em>(not
  38. a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span></code>,
  39. the description corresponds only to the case where <code class="computeroutput"><span class="identifier">T</span></code>
  40. is not of reference type.
  41. </li>
  42. <li class="listitem">
  43. If the entry reads: <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span></code>, the description corresponds
  44. only to the case where <code class="computeroutput"><span class="identifier">T</span></code>
  45. is of reference type.
  46. </li>
  47. <li class="listitem">
  48. If the entry reads: <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code>, the description is the same for
  49. both cases.
  50. </li>
  51. </ul></div>
  52. <div class="note"><table border="0" summary="Note">
  53. <tr>
  54. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  55. <th align="left">Note</th>
  56. </tr>
  57. <tr><td align="left" valign="top"><p>
  58. The following section contains various <code class="computeroutput"><span class="identifier">assert</span><span class="special">()</span></code> which are used only to show the postconditions
  59. as sample code. It is not implied that the type <code class="computeroutput"><span class="identifier">T</span></code>
  60. must support each particular expression but that if the expression is
  61. supported, the implied condition holds.
  62. </p></td></tr>
  63. </table></div>
  64. <p>
  65. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  66. </p>
  67. <h6>
  68. <a name="boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.h0"></a>
  69. <span class="phrase"><a name="boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.optional_class_member_functions"></a></span><a class="link" href="detailed_semantics.html#boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.optional_class_member_functions">optional
  70. class member functions</a>
  71. </h6>
  72. <p>
  73. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  74. </p>
  75. <a name="reference_optional_constructor"></a><div class="blockquote"><blockquote class="blockquote"><p>
  76. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">()</span>
  77. <span class="keyword">noexcept</span><span class="special">;</span></code>
  78. </p></blockquote></div>
  79. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  80. <li class="listitem">
  81. <span class="bold"><strong>Effect:</strong></span> Default-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  82. </li>
  83. <li class="listitem">
  84. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">uninitialized</span>.
  85. </li>
  86. <li class="listitem">
  87. <span class="bold"><strong>Notes:</strong></span> T's default constructor <span class="underline">is not</span> called.
  88. </li>
  89. <li class="listitem">
  90. <span class="bold"><strong>Example:</strong></span>
  91. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  92. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">def</span> <span class="special">)</span> <span class="special">;</span>
  93. </pre>
  94. </li>
  95. </ul></div>
  96. <p>
  97. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  98. </p>
  99. <a name="reference_optional_constructor_none_t"></a><div class="blockquote"><blockquote class="blockquote"><p>
  100. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  101. <span class="identifier">none_t</span> <span class="special">)</span>
  102. <span class="keyword">noexcept</span><span class="special">;</span></code>
  103. </p></blockquote></div>
  104. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  105. <li class="listitem">
  106. <span class="bold"><strong>Effect:</strong></span> Constructs an <code class="computeroutput"><span class="identifier">optional</span></code> uninitialized.
  107. </li>
  108. <li class="listitem">
  109. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">uninitialized</span>.
  110. </li>
  111. <li class="listitem">
  112. <span class="bold"><strong>Notes:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>'s
  113. default constructor <span class="underline">is not</span> called.
  114. The expression <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">none</span></code>
  115. denotes an instance of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">none_t</span></code>
  116. that can be used as the parameter.
  117. </li>
  118. <li class="listitem">
  119. <span class="bold"><strong>Example:</strong></span>
  120. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">none</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  121. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">n</span><span class="special">(</span><span class="identifier">none</span><span class="special">)</span> <span class="special">;</span>
  122. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">n</span> <span class="special">)</span> <span class="special">;</span>
  123. </pre>
  124. </li>
  125. </ul></div>
  126. <p>
  127. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  128. </p>
  129. <a name="reference_optional_constructor_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  130. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span></code>
  131. </p></blockquote></div>
  132. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  133. <li class="listitem">
  134. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">is_copy_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
  135. is <code class="computeroutput"><span class="keyword">true</span></code>.
  136. </li>
  137. <li class="listitem">
  138. <span class="bold"><strong>Effect:</strong></span> Directly-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  139. </li>
  140. <li class="listitem">
  141. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>
  142. and its value is a <span class="emphasis"><em>copy</em></span> of <code class="computeroutput"><span class="identifier">v</span></code>.
  143. </li>
  144. <li class="listitem">
  145. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  146. <span class="special">)</span></code> throws.
  147. </li>
  148. <li class="listitem">
  149. <span class="bold"><strong>Notes: </strong></span> <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  150. <span class="special">)</span></code> is called.
  151. </li>
  152. <li class="listitem">
  153. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  154. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  155. <span class="special">);</span></code> in that case, this constructor
  156. has no effect.
  157. </li>
  158. <li class="listitem">
  159. <span class="bold"><strong>Example:</strong></span>
  160. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  161. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  162. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  163. </pre>
  164. </li>
  165. </ul></div>
  166. <p>
  167. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  168. </p>
  169. <div class="blockquote"><blockquote class="blockquote"><p>
  170. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  171. <span class="identifier">T</span><span class="special">&amp;</span>
  172. <span class="identifier">ref</span> <span class="special">)</span></code>
  173. </p></blockquote></div>
  174. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  175. <li class="listitem">
  176. <span class="bold"><strong>Effect:</strong></span> Directly-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  177. </li>
  178. <li class="listitem">
  179. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>
  180. and its value is an instance of an internal type wrapping the reference
  181. <code class="computeroutput"><span class="identifier">ref</span></code>.
  182. </li>
  183. <li class="listitem">
  184. <span class="bold"><strong>Throws:</strong></span> Nothing.
  185. </li>
  186. <li class="listitem">
  187. <span class="bold"><strong>Example:</strong></span>
  188. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  189. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">vref</span> <span class="special">=</span> <span class="identifier">v</span> <span class="special">;</span>
  190. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">vref</span><span class="special">);</span>
  191. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  192. <span class="special">++</span> <span class="identifier">v</span> <span class="special">;</span> <span class="comment">// mutate referee</span>
  193. <span class="identifier">assert</span> <span class="special">(*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">v</span><span class="special">);</span>
  194. </pre>
  195. </li>
  196. </ul></div>
  197. <p>
  198. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  199. </p>
  200. <a name="reference_optional_constructor_move_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  201. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">v</span>
  202. <span class="special">)</span></code>
  203. </p></blockquote></div>
  204. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  205. <li class="listitem">
  206. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">is_move_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
  207. is <code class="computeroutput"><span class="keyword">true</span></code>.
  208. </li>
  209. <li class="listitem">
  210. <span class="bold"><strong>Effect:</strong></span> Directly-Move-Constructs an
  211. <code class="computeroutput"><span class="identifier">optional</span></code>.
  212. </li>
  213. <li class="listitem">
  214. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>
  215. and its value is move-constructed from <code class="computeroutput"><span class="identifier">v</span></code>.
  216. </li>
  217. <li class="listitem">
  218. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  219. throws.
  220. </li>
  221. <li class="listitem">
  222. <span class="bold"><strong>Notes: </strong></span> <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  223. is called.
  224. </li>
  225. <li class="listitem">
  226. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  227. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">);</span></code>
  228. in that case, the state of <code class="computeroutput"><span class="identifier">v</span></code>
  229. is determined by exception safety guarantees for <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;&amp;)</span></code>.
  230. </li>
  231. <li class="listitem">
  232. <span class="bold"><strong>Example:</strong></span>
  233. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v1</span><span class="special">,</span> <span class="identifier">v2</span><span class="special">;</span>
  234. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">v1</span><span class="special">));</span>
  235. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">v2</span> <span class="special">)</span> <span class="special">;</span>
  236. </pre>
  237. </li>
  238. </ul></div>
  239. <p>
  240. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  241. </p>
  242. <div class="blockquote"><blockquote class="blockquote"><p>
  243. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  244. <span class="identifier">T</span><span class="special">&amp;&amp;</span>
  245. <span class="identifier">ref</span> <span class="special">)</span>
  246. <span class="special">=</span> <span class="keyword">delete</span></code>
  247. </p></blockquote></div>
  248. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  249. <span class="bold"><strong>Notes:</strong></span> This constructor is deleted
  250. </li></ul></div>
  251. <p>
  252. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  253. </p>
  254. <a name="reference_optional_constructor_bool_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  255. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="keyword">bool</span> <span class="identifier">condition</span><span class="special">,</span>
  256. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span></code>
  257. </p></blockquote></div>
  258. <div class="blockquote"><blockquote class="blockquote"><p>
  259. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  260. <span class="special">::</span><span class="identifier">optional</span><span class="special">(</span> <span class="keyword">bool</span> <span class="identifier">condition</span><span class="special">,</span>
  261. <span class="identifier">T</span><span class="special">&amp;</span>
  262. <span class="identifier">v</span> <span class="special">)</span>
  263. <span class="special">;</span></code>
  264. </p></blockquote></div>
  265. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  266. If condition is true, same as:
  267. </li></ul></div>
  268. <div class="blockquote"><blockquote class="blockquote"><p>
  269. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span></code>
  270. </p></blockquote></div>
  271. <div class="blockquote"><blockquote class="blockquote"><p>
  272. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  273. <span class="special">::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span></code>
  274. </p></blockquote></div>
  275. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  276. otherwise, same as:
  277. </li></ul></div>
  278. <div class="blockquote"><blockquote class="blockquote"><p>
  279. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">()</span></code>
  280. </p></blockquote></div>
  281. <div class="blockquote"><blockquote class="blockquote"><p>
  282. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  283. <span class="special">::</span><span class="identifier">optional</span><span class="special">()</span></code>
  284. </p></blockquote></div>
  285. <p>
  286. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  287. </p>
  288. <a name="reference_optional_constructor_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  289. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">optional</span>
  290. <span class="keyword">const</span><span class="special">&amp;</span>
  291. <span class="identifier">rhs</span> <span class="special">);</span></code>
  292. </p></blockquote></div>
  293. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  294. <li class="listitem">
  295. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">is_copy_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
  296. is <code class="computeroutput"><span class="keyword">true</span></code>.
  297. </li>
  298. <li class="listitem">
  299. <span class="bold"><strong>Effect:</strong></span> Copy-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  300. </li>
  301. <li class="listitem">
  302. <span class="bold"><strong>Postconditions:</strong></span> If rhs is initialized,
  303. <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  304. is initialized and its value is a <span class="emphasis"><em>copy</em></span> of the
  305. value of <code class="computeroutput"><span class="identifier">rhs</span></code>; else
  306. <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  307. is uninitialized.
  308. </li>
  309. <li class="listitem">
  310. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  311. <span class="special">)</span></code> throws.
  312. </li>
  313. <li class="listitem">
  314. <span class="bold"><strong>Notes:</strong></span> If rhs is initialized, <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="special">)</span></code>
  315. is called.
  316. </li>
  317. <li class="listitem">
  318. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  319. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  320. <span class="special">);</span></code> in that case, this constructor
  321. has no effect.
  322. </li>
  323. <li class="listitem">
  324. <span class="bold"><strong>Example:</strong></span>
  325. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">uninit</span> <span class="special">;</span>
  326. <span class="identifier">assert</span> <span class="special">(!</span><span class="identifier">uninit</span><span class="special">);</span>
  327. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">uinit2</span> <span class="special">(</span> <span class="identifier">uninit</span> <span class="special">)</span> <span class="special">;</span>
  328. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">uninit2</span> <span class="special">==</span> <span class="identifier">uninit</span> <span class="special">);</span>
  329. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">init</span><span class="special">(</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">)</span> <span class="special">);</span>
  330. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init</span> <span class="special">==</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  331. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">init2</span> <span class="special">(</span> <span class="identifier">init</span> <span class="special">)</span> <span class="special">;</span>
  332. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">init2</span> <span class="special">==</span> <span class="identifier">init</span> <span class="special">)</span> <span class="special">;</span>
  333. </pre>
  334. </li>
  335. </ul></div>
  336. <p>
  337. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  338. </p>
  339. <div class="blockquote"><blockquote class="blockquote"><p>
  340. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  341. <span class="identifier">optional</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span>
  342. <span class="special">);</span></code>
  343. </p></blockquote></div>
  344. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  345. <li class="listitem">
  346. <span class="bold"><strong>Effect:</strong></span> Copy-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  347. </li>
  348. <li class="listitem">
  349. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  350. is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  351. is initialized and its value is another reference to the same object
  352. referenced by <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>;
  353. else <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  354. is uninitialized.
  355. </li>
  356. <li class="listitem">
  357. <span class="bold"><strong>Throws:</strong></span> Nothing.
  358. </li>
  359. <li class="listitem">
  360. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  361. is initialized, both <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> will refer to the same object
  362. (they alias).
  363. </li>
  364. <li class="listitem">
  365. <span class="bold"><strong>Example:</strong></span>
  366. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">uninit</span> <span class="special">;</span>
  367. <span class="identifier">assert</span> <span class="special">(!</span><span class="identifier">uninit</span><span class="special">);</span>
  368. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">uinit2</span> <span class="special">(</span> <span class="identifier">uninit</span> <span class="special">)</span> <span class="special">;</span>
  369. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">uninit2</span> <span class="special">==</span> <span class="identifier">uninit</span> <span class="special">);</span>
  370. <span class="identifier">T</span> <span class="identifier">v</span> <span class="special">=</span> <span class="number">2</span> <span class="special">;</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">ref</span> <span class="special">=</span> <span class="identifier">v</span> <span class="special">;</span>
  371. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">init</span><span class="special">(</span><span class="identifier">ref</span><span class="special">);</span>
  372. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  373. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">init2</span> <span class="special">(</span> <span class="identifier">init</span> <span class="special">)</span> <span class="special">;</span>
  374. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init2</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  375. <span class="identifier">v</span> <span class="special">=</span> <span class="number">3</span> <span class="special">;</span>
  376. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init</span> <span class="special">==</span> <span class="number">3</span> <span class="special">)</span> <span class="special">;</span>
  377. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init2</span> <span class="special">==</span> <span class="number">3</span> <span class="special">)</span> <span class="special">;</span>
  378. </pre>
  379. </li>
  380. </ul></div>
  381. <p>
  382. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  383. </p>
  384. <a name="reference_optional_move_constructor_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  385. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span> <span class="identifier">optional</span><span class="special">&amp;&amp;</span> <span class="identifier">rhs</span>
  386. <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span></code><span class="emphasis"><em>see below</em></span><code class="computeroutput"><span class="special">);</span></code>
  387. </p></blockquote></div>
  388. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  389. <li class="listitem">
  390. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">is_move_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
  391. is <code class="computeroutput"><span class="keyword">true</span></code>.
  392. </li>
  393. <li class="listitem">
  394. <span class="bold"><strong>Effect:</strong></span> Move-constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  395. </li>
  396. <li class="listitem">
  397. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  398. is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  399. is initialized and its value is move constructed from <code class="computeroutput"><span class="identifier">rhs</span></code>; else <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is uninitialized.
  400. </li>
  401. <li class="listitem">
  402. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  403. throws.
  404. </li>
  405. <li class="listitem">
  406. <span class="bold"><strong>Remarks:</strong></span> The expression inside <code class="computeroutput"><span class="keyword">noexcept</span></code> is equivalent to <code class="computeroutput"><span class="identifier">is_nothrow_move_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>.
  407. </li>
  408. <li class="listitem">
  409. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  410. is initialized, <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span> <span class="special">&amp;&amp;</span>
  411. <span class="special">)</span></code> is called.
  412. </li>
  413. <li class="listitem">
  414. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  415. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">);</span></code>
  416. in that case, <code class="computeroutput"><span class="identifier">rhs</span></code> remains
  417. initialized and the value of <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> is determined by exception safety
  418. of <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;&amp;)</span></code>.
  419. </li>
  420. <li class="listitem">
  421. <span class="bold"><strong>Example:</strong></span>
  422. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&gt;</span> <span class="identifier">uninit</span> <span class="special">;</span>
  423. <span class="identifier">assert</span> <span class="special">(!</span><span class="identifier">uninit</span><span class="special">);</span>
  424. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&gt;</span> <span class="identifier">uinit2</span> <span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">uninit</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  425. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">uninit2</span> <span class="special">==</span> <span class="identifier">uninit</span> <span class="special">);</span>
  426. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&gt;</span> <span class="identifier">init</span><span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">uniqye_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;(</span><span class="keyword">new</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">))</span> <span class="special">);</span>
  427. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">**</span><span class="identifier">init</span> <span class="special">==</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  428. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&gt;</span> <span class="identifier">init2</span> <span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">init</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  429. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">init</span> <span class="special">);</span>
  430. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init</span> <span class="special">==</span> <span class="keyword">nullptr</span> <span class="special">);</span>
  431. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">init2</span> <span class="special">);</span>
  432. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">**</span><span class="identifier">init2</span> <span class="special">==</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  433. </pre>
  434. </li>
  435. </ul></div>
  436. <p>
  437. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  438. </p>
  439. <div class="blockquote"><blockquote class="blockquote"><p>
  440. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  441. <span class="identifier">optional</span> <span class="special">&amp;&amp;</span>
  442. <span class="identifier">rhs</span> <span class="special">);</span></code>
  443. </p></blockquote></div>
  444. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  445. <li class="listitem">
  446. <span class="bold"><strong>Effect:</strong></span> Move-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  447. </li>
  448. <li class="listitem">
  449. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  450. is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  451. is initialized and its value is another reference to the same object
  452. referenced by <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>;
  453. else <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  454. is uninitialized.
  455. </li>
  456. <li class="listitem">
  457. <span class="bold"><strong>Throws:</strong></span> Nothing.
  458. </li>
  459. <li class="listitem">
  460. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  461. is initialized, both <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> will refer to the same object
  462. (they alias).
  463. </li>
  464. <li class="listitem">
  465. <span class="bold"><strong>Example:</strong></span>
  466. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;&gt;</span> <span class="identifier">uninit</span> <span class="special">;</span>
  467. <span class="identifier">assert</span> <span class="special">(!</span><span class="identifier">uninit</span><span class="special">);</span>
  468. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;&gt;</span> <span class="identifier">uinit2</span> <span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">uninit</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  469. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">uninit2</span> <span class="special">==</span> <span class="identifier">uninit</span> <span class="special">);</span>
  470. <span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="keyword">new</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">))</span> <span class="special">;</span>
  471. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;&gt;</span> <span class="identifier">init</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  472. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  473. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;&gt;</span> <span class="identifier">init2</span> <span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">init</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  474. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">init2</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  475. <span class="special">*</span><span class="identifier">v</span> <span class="special">=</span> <span class="number">3</span> <span class="special">;</span>
  476. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">**</span><span class="identifier">init</span> <span class="special">==</span> <span class="number">3</span> <span class="special">)</span> <span class="special">;</span>
  477. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">**</span><span class="identifier">init2</span> <span class="special">==</span> <span class="number">3</span> <span class="special">)</span> <span class="special">;</span>
  478. </pre>
  479. </li>
  480. </ul></div>
  481. <p>
  482. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  483. </p>
  484. <a name="reference_optional_constructor_other_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  485. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="keyword">explicit</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  486. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  487. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span> <span class="special">);</span></code>
  488. </p></blockquote></div>
  489. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  490. <li class="listitem">
  491. <span class="bold"><strong>Effect:</strong></span> Copy-Constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  492. </li>
  493. <li class="listitem">
  494. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  495. is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  496. is initialized and its value is a <span class="emphasis"><em>copy</em></span> of the
  497. value of rhs converted to type <code class="computeroutput"><span class="identifier">T</span></code>;
  498. else <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  499. is uninitialized.
  500. </li>
  501. <li class="listitem">
  502. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span> <span class="keyword">const</span><span class="special">&amp;</span>
  503. <span class="special">)</span></code> throws.
  504. </li>
  505. <li class="listitem">
  506. <span class="bold"><strong>Notes: </strong></span> <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span> <span class="keyword">const</span><span class="special">&amp;</span>
  507. <span class="special">)</span></code> is called if <code class="computeroutput"><span class="identifier">rhs</span></code> is initialized, which requires
  508. a valid conversion from <code class="computeroutput"><span class="identifier">U</span></code>
  509. to <code class="computeroutput"><span class="identifier">T</span></code>.
  510. </li>
  511. <li class="listitem">
  512. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  513. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span> <span class="keyword">const</span><span class="special">&amp;</span>
  514. <span class="special">);</span></code> in that case, this constructor
  515. has no effect.
  516. </li>
  517. <li class="listitem">
  518. <span class="bold"><strong>Example:</strong></span>
  519. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">x</span><span class="special">(</span><span class="number">123.4</span><span class="special">);</span>
  520. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">x</span> <span class="special">==</span> <span class="number">123.4</span> <span class="special">)</span> <span class="special">;</span>
  521. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">y</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">;</span>
  522. <span class="identifier">assert</span><span class="special">(</span> <span class="special">*</span><span class="identifier">y</span> <span class="special">==</span> <span class="number">123</span> <span class="special">)</span> <span class="special">;</span>
  523. </pre>
  524. </li>
  525. </ul></div>
  526. <p>
  527. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  528. </p>
  529. <a name="reference_optional_move_constructor_other_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  530. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="keyword">explicit</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  531. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  532. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;&amp;&amp;</span>
  533. <span class="identifier">rhs</span> <span class="special">);</span></code>
  534. </p></blockquote></div>
  535. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  536. <li class="listitem">
  537. <span class="bold"><strong>Effect:</strong></span> Move-constructs an <code class="computeroutput"><span class="identifier">optional</span></code>.
  538. </li>
  539. <li class="listitem">
  540. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="identifier">rhs</span></code>
  541. is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  542. is initialized and its value is move-constructed from <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>;
  543. else <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  544. is uninitialized.
  545. </li>
  546. <li class="listitem">
  547. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  548. throws.
  549. </li>
  550. <li class="listitem">
  551. <span class="bold"><strong>Notes: </strong></span> <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  552. is called if <code class="computeroutput"><span class="identifier">rhs</span></code> is
  553. initialized, which requires a valid conversion from <code class="computeroutput"><span class="identifier">U</span></code>
  554. to <code class="computeroutput"><span class="identifier">T</span></code>.
  555. </li>
  556. <li class="listitem">
  557. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  558. be thrown during <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span><span class="special">&amp;&amp;</span> <span class="special">);</span></code>
  559. in that case, <code class="computeroutput"><span class="identifier">rhs</span></code> remains
  560. initialized and the value of <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> is determined by exception safety
  561. guarantee of <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span> <span class="identifier">U</span><span class="special">&amp;&amp;</span>
  562. <span class="special">)</span></code>.
  563. </li>
  564. <li class="listitem">
  565. <span class="bold"><strong>Example:</strong></span>
  566. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">x</span><span class="special">(</span><span class="number">123.4</span><span class="special">);</span>
  567. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">x</span> <span class="special">==</span> <span class="number">123.4</span> <span class="special">)</span> <span class="special">;</span>
  568. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">y</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">x</span><span class="special">))</span> <span class="special">;</span>
  569. <span class="identifier">assert</span><span class="special">(</span> <span class="special">*</span><span class="identifier">y</span> <span class="special">==</span> <span class="number">123</span> <span class="special">)</span> <span class="special">;</span>
  570. </pre>
  571. </li>
  572. </ul></div>
  573. <p>
  574. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  575. </p>
  576. <a name="reference_optional_constructor_factory"></a><div class="blockquote"><blockquote class="blockquote"><p>
  577. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">InPlaceFactory</span><span class="special">&gt;</span>
  578. <span class="keyword">explicit</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  579. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  580. <span class="identifier">InPlaceFactory</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">f</span> <span class="special">);</span></code>
  581. </p></blockquote></div>
  582. <div class="blockquote"><blockquote class="blockquote"><p>
  583. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">TypedInPlaceFactory</span><span class="special">&gt;</span>
  584. <span class="keyword">explicit</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  585. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">optional</span><span class="special">(</span>
  586. <span class="identifier">TypedInPlaceFactory</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">f</span> <span class="special">);</span></code>
  587. </p></blockquote></div>
  588. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  589. <li class="listitem">
  590. <span class="bold"><strong>Effect:</strong></span> Constructs an <code class="computeroutput"><span class="identifier">optional</span></code> with a value of <code class="computeroutput"><span class="identifier">T</span></code> obtained from the factory.
  591. </li>
  592. <li class="listitem">
  593. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>
  594. and its value is <span class="emphasis"><em>directly given</em></span> from the factory
  595. <code class="computeroutput"><span class="identifier">f</span></code> (i.e., the value
  596. <span class="underline">is not copied</span>).
  597. </li>
  598. <li class="listitem">
  599. <span class="bold"><strong>Throws:</strong></span> Whatever the <code class="computeroutput"><span class="identifier">T</span></code> constructor called by the factory
  600. throws.
  601. </li>
  602. <li class="listitem">
  603. <span class="bold"><strong>Notes:</strong></span> See <a class="link" href="../../tutorial/in_place_factories.html" title="In-Place Factories">In-Place
  604. Factories</a>
  605. </li>
  606. <li class="listitem">
  607. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  608. be thrown during the call to the <code class="computeroutput"><span class="identifier">T</span></code>
  609. constructor used by the factory; in that case, this constructor has
  610. no effect.
  611. </li>
  612. <li class="listitem">
  613. <span class="bold"><strong>Example:</strong></span>
  614. <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">C</span> <span class="special">{</span> <span class="identifier">C</span> <span class="special">(</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">)</span> <span class="special">;</span> <span class="special">}</span> <span class="special">;</span>
  615. <span class="identifier">C</span> <span class="identifier">v</span><span class="special">(</span><span class="char">'A'</span><span class="special">,</span><span class="number">123.4</span><span class="special">,</span><span class="string">"hello"</span><span class="special">);</span>
  616. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">C</span><span class="special">&gt;</span> <span class="identifier">x</span><span class="special">(</span> <span class="identifier">in_place</span> <span class="special">(</span><span class="char">'A'</span><span class="special">,</span> <span class="number">123.4</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">)</span> <span class="special">);</span> <span class="comment">// InPlaceFactory used</span>
  617. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">C</span><span class="special">&gt;</span> <span class="identifier">y</span><span class="special">(</span> <span class="identifier">in_place</span><span class="special">&lt;</span><span class="identifier">C</span><span class="special">&gt;(</span><span class="char">'A'</span><span class="special">,</span> <span class="number">123.4</span><span class="special">,</span> <span class="string">"hello"</span><span class="special">)</span> <span class="special">);</span> <span class="comment">// TypedInPlaceFactory used</span>
  618. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">x</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  619. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">y</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  620. </pre>
  621. </li>
  622. </ul></div>
  623. <p>
  624. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  625. </p>
  626. <a name="reference_optional_operator_equal_none_t"></a><div class="blockquote"><blockquote class="blockquote"><p>
  627. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&amp;</span>
  628. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">none_t</span>
  629. <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></code>
  630. </p></blockquote></div>
  631. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  632. <li class="listitem">
  633. <span class="bold"><strong>Effect:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized destroys its contained
  634. value.
  635. </li>
  636. <li class="listitem">
  637. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is uninitialized.
  638. </li>
  639. </ul></div>
  640. <p>
  641. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  642. </p>
  643. <a name="reference_optional_operator_equal_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  644. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&amp;</span>
  645. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">T</span>
  646. <span class="keyword">const</span><span class="special">&amp;</span>
  647. <span class="identifier">rhs</span> <span class="special">)</span>
  648. <span class="special">;</span></code>
  649. </p></blockquote></div>
  650. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  651. <li class="listitem">
  652. <span class="bold"><strong>Effect:</strong></span> Assigns the value <code class="computeroutput"><span class="identifier">rhs</span></code> to an <code class="computeroutput"><span class="identifier">optional</span></code>.
  653. </li>
  654. <li class="listitem">
  655. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized and its value is
  656. a <span class="emphasis"><em>copy</em></span> of <code class="computeroutput"><span class="identifier">rhs</span></code>.
  657. </li>
  658. <li class="listitem">
  659. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span>
  660. <span class="special">)</span></code> or <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;)</span></code>
  661. throws.
  662. </li>
  663. <li class="listitem">
  664. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> was initialized, <code class="computeroutput"><span class="identifier">T</span></code>'s assignment operator is used,
  665. otherwise, its copy-constructor is used.
  666. </li>
  667. <li class="listitem">
  668. <span class="bold"><strong>Exception Safety:</strong></span> In the event of
  669. an exception, the initialization state of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is unchanged and its value unspecified
  670. as far as <code class="computeroutput"><span class="identifier">optional</span></code>
  671. is concerned (it is up to <code class="computeroutput"><span class="identifier">T</span></code>'s
  672. <code class="computeroutput"><span class="keyword">operator</span><span class="special">=()</span></code>).
  673. If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  674. is initially uninitialized and <code class="computeroutput"><span class="identifier">T</span></code>'s
  675. <span class="emphasis"><em>copy constructor</em></span> fails, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is left properly uninitialized.
  676. </li>
  677. <li class="listitem">
  678. <span class="bold"><strong>Example:</strong></span>
  679. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">x</span><span class="special">;</span>
  680. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  681. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">;</span>
  682. <span class="identifier">T</span> <span class="identifier">y</span><span class="special">;</span>
  683. <span class="identifier">def</span> <span class="special">=</span> <span class="identifier">y</span> <span class="special">;</span>
  684. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">def</span> <span class="special">==</span> <span class="identifier">y</span> <span class="special">)</span> <span class="special">;</span>
  685. <span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">y</span> <span class="special">;</span>
  686. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">y</span> <span class="special">)</span> <span class="special">;</span>
  687. </pre>
  688. </li>
  689. </ul></div>
  690. <p>
  691. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  692. </p>
  693. <div class="blockquote"><blockquote class="blockquote"><p>
  694. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;&amp;</span>
  695. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">rhs</span>
  696. <span class="special">)</span> <span class="special">;</span></code>
  697. </p></blockquote></div>
  698. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  699. <li class="listitem">
  700. <span class="bold"><strong>Effect:</strong></span> (Re)binds the wrapped reference.
  701. </li>
  702. <li class="listitem">
  703. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized and it references
  704. the same object referenced by <code class="computeroutput"><span class="identifier">rhs</span></code>.
  705. </li>
  706. <li class="listitem">
  707. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> was initialized, it is <span class="emphasis"><em>rebound</em></span>
  708. to the new object. See <a class="link" href="../../tutorial/rebinding_semantics_for_assignment_of_optional_references.html" title="Rebinding semantics for assignment of optional references">here</a>
  709. for details on this behavior.
  710. </li>
  711. <li class="listitem">
  712. <span class="bold"><strong>Example:</strong></span>
  713. <pre class="programlisting"><span class="keyword">int</span> <span class="identifier">a</span> <span class="special">=</span> <span class="number">1</span> <span class="special">;</span>
  714. <span class="keyword">int</span> <span class="identifier">b</span> <span class="special">=</span> <span class="number">2</span> <span class="special">;</span>
  715. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">ra</span> <span class="special">=</span> <span class="identifier">a</span> <span class="special">;</span>
  716. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">rb</span> <span class="special">=</span> <span class="identifier">b</span> <span class="special">;</span>
  717. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  718. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">ra</span><span class="special">)</span> <span class="special">;</span>
  719. <span class="identifier">def</span> <span class="special">=</span> <span class="identifier">rb</span> <span class="special">;</span> <span class="comment">// binds 'def' to 'b' through 'rb'</span>
  720. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">def</span> <span class="special">==</span> <span class="identifier">b</span> <span class="special">)</span> <span class="special">;</span>
  721. <span class="special">*</span><span class="identifier">def</span> <span class="special">=</span> <span class="identifier">a</span> <span class="special">;</span> <span class="comment">// changes the value of 'b' to a copy of the value of 'a'</span>
  722. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">b</span> <span class="special">==</span> <span class="identifier">a</span> <span class="special">)</span> <span class="special">;</span>
  723. <span class="keyword">int</span> <span class="identifier">c</span> <span class="special">=</span> <span class="number">3</span><span class="special">;</span>
  724. <span class="keyword">int</span><span class="special">&amp;</span> <span class="identifier">rc</span> <span class="special">=</span> <span class="identifier">c</span> <span class="special">;</span>
  725. <span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">rc</span> <span class="special">;</span> <span class="comment">// REBINDS to 'c' through 'rc'</span>
  726. <span class="identifier">c</span> <span class="special">=</span> <span class="number">4</span> <span class="special">;</span>
  727. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="number">4</span> <span class="special">)</span> <span class="special">;</span>
  728. </pre>
  729. </li>
  730. </ul></div>
  731. <p>
  732. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  733. </p>
  734. <a name="reference_optional_operator_move_equal_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  735. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&amp;</span>
  736. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">rhs</span>
  737. <span class="special">)</span> <span class="special">;</span></code>
  738. </p></blockquote></div>
  739. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  740. <li class="listitem">
  741. <span class="bold"><strong>Effect:</strong></span> Moves the value <code class="computeroutput"><span class="identifier">rhs</span></code> to an <code class="computeroutput"><span class="identifier">optional</span></code>.
  742. </li>
  743. <li class="listitem">
  744. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized and its value is
  745. moved from <code class="computeroutput"><span class="identifier">rhs</span></code>.
  746. </li>
  747. <li class="listitem">
  748. <span class="bold"><strong>Throws:</strong></span> Whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  749. or <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&amp;&amp;)</span></code>
  750. throws.
  751. </li>
  752. <li class="listitem">
  753. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> was initialized, <code class="computeroutput"><span class="identifier">T</span></code>'s move-assignment operator is used,
  754. otherwise, its move-constructor is used.
  755. </li>
  756. <li class="listitem">
  757. <span class="bold"><strong>Exception Safety:</strong></span> In the event of
  758. an exception, the initialization state of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is unchanged and its value unspecified
  759. as far as <code class="computeroutput"><span class="identifier">optional</span></code>
  760. is concerned (it is up to <code class="computeroutput"><span class="identifier">T</span></code>'s
  761. <code class="computeroutput"><span class="keyword">operator</span><span class="special">=()</span></code>).
  762. If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  763. is initially uninitialized and <code class="computeroutput"><span class="identifier">T</span></code>'s
  764. <span class="emphasis"><em>move constructor</em></span> fails, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is left properly uninitialized.
  765. </li>
  766. <li class="listitem">
  767. <span class="bold"><strong>Example:</strong></span>
  768. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">x</span><span class="special">;</span>
  769. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  770. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">x</span><span class="special">)</span> <span class="special">;</span>
  771. <span class="identifier">T</span> <span class="identifier">y1</span><span class="special">,</span> <span class="identifier">y2</span><span class="special">,</span> <span class="identifier">yR</span><span class="special">;</span>
  772. <span class="identifier">def</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">y1</span><span class="special">)</span> <span class="special">;</span>
  773. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">def</span> <span class="special">==</span> <span class="identifier">yR</span> <span class="special">)</span> <span class="special">;</span>
  774. <span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">y2</span><span class="special">)</span> <span class="special">;</span>
  775. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">yR</span> <span class="special">)</span> <span class="special">;</span>
  776. </pre>
  777. </li>
  778. </ul></div>
  779. <p>
  780. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  781. </p>
  782. <div class="blockquote"><blockquote class="blockquote"><p>
  783. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;&amp;</span>
  784. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">rhs</span>
  785. <span class="special">)</span> <span class="special">=</span>
  786. <span class="keyword">delete</span><span class="special">;</span></code>
  787. </p></blockquote></div>
  788. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  789. <span class="bold"><strong>Notes:</strong></span> This assignment operator is
  790. deleted.
  791. </li></ul></div>
  792. <p>
  793. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  794. </p>
  795. <a name="reference_optional_operator_equal_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  796. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&amp;</span>
  797. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span>
  798. <span class="keyword">const</span><span class="special">&amp;</span>
  799. <span class="identifier">rhs</span> <span class="special">)</span>
  800. <span class="special">;</span></code>
  801. </p></blockquote></div>
  802. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  803. <li class="listitem">
  804. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  805. is <a href="../../../../../../utility/CopyConstructible.html" target="_top"><code class="computeroutput"><span class="identifier">CopyConstructible</span></code></a> and <code class="computeroutput"><span class="identifier">CopyAssignable</span></code>.
  806. </li>
  807. <li class="listitem">
  808. <p class="simpara">
  809. <span class="bold"><strong>Effects:</strong></span>
  810. </p>
  811. <div class="informaltable"><table class="table">
  812. <colgroup>
  813. <col>
  814. <col>
  815. <col>
  816. </colgroup>
  817. <thead><tr></tr></thead>
  818. <tbody>
  819. <tr>
  820. <td>
  821. </td>
  822. <td>
  823. <p>
  824. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value</strong></span>
  825. </p>
  826. </td>
  827. <td>
  828. <p>
  829. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value</strong></span>
  830. </p>
  831. </td>
  832. </tr>
  833. <tr>
  834. <td>
  835. <p>
  836. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  837. contains a value</strong></span>
  838. </p>
  839. </td>
  840. <td>
  841. <p>
  842. assigns <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>
  843. to the contained value
  844. </p>
  845. </td>
  846. <td>
  847. <p>
  848. initializes the contained value as if direct-initializing
  849. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  850. with <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>
  851. </p>
  852. </td>
  853. </tr>
  854. <tr>
  855. <td>
  856. <p>
  857. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  858. does not contain a value</strong></span>
  859. </p>
  860. </td>
  861. <td>
  862. <p>
  863. destroys the contained value by calling <code class="computeroutput"><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>
  864. </p>
  865. </td>
  866. <td>
  867. <p>
  868. no effect
  869. </p>
  870. </td>
  871. </tr>
  872. </tbody>
  873. </table></div>
  874. </li>
  875. <li class="listitem">
  876. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>;
  877. </li>
  878. <li class="listitem">
  879. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="keyword">bool</span><span class="special">(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code>.
  880. </li>
  881. <li class="listitem">
  882. <span class="bold"><strong>Exception Safety:</strong></span> If any exception
  883. is thrown, the initialization state of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="identifier">rhs</span></code>
  884. remains unchanged. If an exception is thrown during the call to <code class="computeroutput"><span class="identifier">T</span></code>'s copy constructor, no effect.
  885. If an exception is thrown during the call to <code class="computeroutput"><span class="identifier">T</span></code>'s
  886. copy assignment, the state of its contained value is as defined by
  887. the exception safety guarantee of <code class="computeroutput"><span class="identifier">T</span></code>'s
  888. copy assignment.
  889. </li>
  890. <li class="listitem">
  891. <span class="bold"><strong>Example:</strong></span>
  892. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  893. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  894. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  895. <span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">def</span> <span class="special">;</span>
  896. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">def</span> <span class="special">)</span> <span class="special">;</span>
  897. <span class="comment">// previous value (copy of 'v') destroyed from within 'opt'.</span>
  898. </pre>
  899. </li>
  900. </ul></div>
  901. <p>
  902. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  903. </p>
  904. <div class="blockquote"><blockquote class="blockquote"><p>
  905. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  906. <span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span>
  907. <span class="special">)</span> <span class="special">;</span></code>
  908. </p></blockquote></div>
  909. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  910. <li class="listitem">
  911. <span class="bold"><strong>Effect:</strong></span> (Re)binds thee wrapped reference.
  912. </li>
  913. <li class="listitem">
  914. <span class="bold"><strong>Postconditions:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> is initialized, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  915. is initialized and it references the same object referenced by <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>;
  916. otherwise, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  917. is uninitialized (and references no object).
  918. </li>
  919. <li class="listitem">
  920. <span class="bold"><strong>Notes:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> was initialized and so is <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>,
  921. <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  922. is <span class="emphasis"><em>rebound</em></span> to the new object. See <a class="link" href="../../tutorial/rebinding_semantics_for_assignment_of_optional_references.html" title="Rebinding semantics for assignment of optional references">here</a>
  923. for details on this behavior.
  924. </li>
  925. <li class="listitem">
  926. <span class="bold"><strong>Example:</strong></span>
  927. <pre class="programlisting"><span class="keyword">int</span> <span class="identifier">a</span> <span class="special">=</span> <span class="number">1</span> <span class="special">;</span>
  928. <span class="keyword">int</span> <span class="identifier">b</span> <span class="special">=</span> <span class="number">2</span> <span class="special">;</span>
  929. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">ra</span> <span class="special">=</span> <span class="identifier">a</span> <span class="special">;</span>
  930. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">rb</span> <span class="special">=</span> <span class="identifier">b</span> <span class="special">;</span>
  931. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  932. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">ora</span><span class="special">(</span><span class="identifier">ra</span><span class="special">)</span> <span class="special">;</span>
  933. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">orb</span><span class="special">(</span><span class="identifier">rb</span><span class="special">)</span> <span class="special">;</span>
  934. <span class="identifier">def</span> <span class="special">=</span> <span class="identifier">orb</span> <span class="special">;</span> <span class="comment">// binds 'def' to 'b' through 'rb' wrapped within 'orb'</span>
  935. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">def</span> <span class="special">==</span> <span class="identifier">b</span> <span class="special">)</span> <span class="special">;</span>
  936. <span class="special">*</span><span class="identifier">def</span> <span class="special">=</span> <span class="identifier">ora</span> <span class="special">;</span> <span class="comment">// changes the value of 'b' to a copy of the value of 'a'</span>
  937. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">b</span> <span class="special">==</span> <span class="identifier">a</span> <span class="special">)</span> <span class="special">;</span>
  938. <span class="keyword">int</span> <span class="identifier">c</span> <span class="special">=</span> <span class="number">3</span><span class="special">;</span>
  939. <span class="keyword">int</span><span class="special">&amp;</span> <span class="identifier">rc</span> <span class="special">=</span> <span class="identifier">c</span> <span class="special">;</span>
  940. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">orc</span><span class="special">(</span><span class="identifier">rc</span><span class="special">)</span> <span class="special">;</span>
  941. <span class="identifier">ora</span> <span class="special">=</span> <span class="identifier">orc</span> <span class="special">;</span> <span class="comment">// REBINDS ora to 'c' through 'rc'</span>
  942. <span class="identifier">c</span> <span class="special">=</span> <span class="number">4</span> <span class="special">;</span>
  943. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">ora</span> <span class="special">==</span> <span class="number">4</span> <span class="special">)</span> <span class="special">;</span>
  944. </pre>
  945. </li>
  946. </ul></div>
  947. <p>
  948. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  949. </p>
  950. <a name="reference_optional_operator_move_equal_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  951. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&amp;</span>
  952. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&amp;&amp;</span> <span class="identifier">rhs</span>
  953. <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span></code><span class="emphasis"><em>see below</em></span><code class="computeroutput"><span class="special">);</span></code>
  954. </p></blockquote></div>
  955. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  956. <li class="listitem">
  957. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  958. is <code class="computeroutput"><span class="identifier">MoveConstructible</span></code>
  959. and <code class="computeroutput"><span class="identifier">MoveAssignable</span></code>.
  960. </li>
  961. <li class="listitem">
  962. <p class="simpara">
  963. <span class="bold"><strong>Effects:</strong></span>
  964. </p>
  965. <div class="informaltable"><table class="table">
  966. <colgroup>
  967. <col>
  968. <col>
  969. <col>
  970. </colgroup>
  971. <thead><tr></tr></thead>
  972. <tbody>
  973. <tr>
  974. <td>
  975. </td>
  976. <td>
  977. <p>
  978. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value</strong></span>
  979. </p>
  980. </td>
  981. <td>
  982. <p>
  983. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value</strong></span>
  984. </p>
  985. </td>
  986. </tr>
  987. <tr>
  988. <td>
  989. <p>
  990. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  991. contains a value</strong></span>
  992. </p>
  993. </td>
  994. <td>
  995. <p>
  996. assigns <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">rhs</span><span class="special">)</span></code> to the contained value
  997. </p>
  998. </td>
  999. <td>
  1000. <p>
  1001. initializes the contained value as if direct-initializing
  1002. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  1003. with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">rhs</span><span class="special">)</span></code>
  1004. </p>
  1005. </td>
  1006. </tr>
  1007. <tr>
  1008. <td>
  1009. <p>
  1010. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  1011. does not contain a value</strong></span>
  1012. </p>
  1013. </td>
  1014. <td>
  1015. <p>
  1016. destroys the contained value by calling <code class="computeroutput"><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>
  1017. </p>
  1018. </td>
  1019. <td>
  1020. <p>
  1021. no effect
  1022. </p>
  1023. </td>
  1024. </tr>
  1025. </tbody>
  1026. </table></div>
  1027. </li>
  1028. <li class="listitem">
  1029. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>;
  1030. </li>
  1031. <li class="listitem">
  1032. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="keyword">bool</span><span class="special">(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code>.
  1033. </li>
  1034. <li class="listitem">
  1035. <span class="bold"><strong>Remarks:</strong></span> The expression inside <code class="computeroutput"><span class="keyword">noexcept</span></code> is equivalent to <code class="computeroutput"><span class="identifier">is_nothrow_move_constructible</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&amp;&amp;</span>
  1036. <span class="identifier">is_nothrow_move_assignable</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span></code>.
  1037. </li>
  1038. <li class="listitem">
  1039. <span class="bold"><strong>Exception Safety:</strong></span> If any exception
  1040. is thrown, the initialization state of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="identifier">rhs</span></code>
  1041. remains unchanged. If an exception is thrown during the call to <code class="computeroutput"><span class="identifier">T</span></code>'s move constructor, the state of
  1042. <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>
  1043. is determined by the exception safety guarantee of <code class="computeroutput"><span class="identifier">T</span></code>'s
  1044. move constructor. If an exception is thrown during the call to T's
  1045. move-assignment, the state of <code class="computeroutput"><span class="special">**</span><span class="keyword">this</span></code> and <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code> is determined by the exception
  1046. safety guarantee of T's move assignment.
  1047. </li>
  1048. <li class="listitem">
  1049. <span class="bold"><strong>Example:</strong></span>
  1050. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">))</span> <span class="special">;</span>
  1051. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  1052. <span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">def</span> <span class="special">;</span>
  1053. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">def</span> <span class="special">)</span> <span class="special">;</span>
  1054. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt</span> <span class="special">)</span> <span class="special">;</span>
  1055. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  1056. </pre>
  1057. </li>
  1058. </ul></div>
  1059. <p>
  1060. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1061. </p>
  1062. <div class="blockquote"><blockquote class="blockquote"><p>
  1063. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  1064. <span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;&amp;&amp;</span> <span class="identifier">rhs</span>
  1065. <span class="special">)</span> <span class="special">;</span></code>
  1066. </p></blockquote></div>
  1067. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  1068. <span class="bold"><strong>Effect:</strong></span> Same as <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  1069. <span class="keyword">const</span><span class="special">&amp;</span>
  1070. <span class="identifier">rhs</span> <span class="special">)</span></code>.
  1071. </li></ul></div>
  1072. <p>
  1073. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1074. </p>
  1075. <a name="reference_optional_operator_equal_other_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1076. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">optional</span><span class="special">&amp;</span>
  1077. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span>
  1078. <span class="special">)</span> <span class="special">;</span></code>
  1079. </p></blockquote></div>
  1080. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1081. <li class="listitem">
  1082. <p class="simpara">
  1083. <span class="bold"><strong>Effect:</strong></span>
  1084. </p>
  1085. <div class="informaltable"><table class="table">
  1086. <colgroup>
  1087. <col>
  1088. <col>
  1089. <col>
  1090. </colgroup>
  1091. <thead><tr></tr></thead>
  1092. <tbody>
  1093. <tr>
  1094. <td>
  1095. </td>
  1096. <td>
  1097. <p>
  1098. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value</strong></span>
  1099. </p>
  1100. </td>
  1101. <td>
  1102. <p>
  1103. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value</strong></span>
  1104. </p>
  1105. </td>
  1106. </tr>
  1107. <tr>
  1108. <td>
  1109. <p>
  1110. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  1111. contains a value</strong></span>
  1112. </p>
  1113. </td>
  1114. <td>
  1115. <p>
  1116. assigns <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>
  1117. to the contained value
  1118. </p>
  1119. </td>
  1120. <td>
  1121. <p>
  1122. initializes the contained value as if direct-initializing
  1123. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  1124. with <code class="computeroutput"><span class="special">*</span><span class="identifier">rhs</span></code>
  1125. </p>
  1126. </td>
  1127. </tr>
  1128. <tr>
  1129. <td>
  1130. <p>
  1131. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  1132. does not contain a value</strong></span>
  1133. </p>
  1134. </td>
  1135. <td>
  1136. <p>
  1137. destroys the contained value by calling <code class="computeroutput"><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>
  1138. </p>
  1139. </td>
  1140. <td>
  1141. <p>
  1142. no effect
  1143. </p>
  1144. </td>
  1145. </tr>
  1146. </tbody>
  1147. </table></div>
  1148. </li>
  1149. <li class="listitem">
  1150. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
  1151. </li>
  1152. <li class="listitem">
  1153. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="keyword">bool</span><span class="special">(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code>.
  1154. </li>
  1155. <li class="listitem">
  1156. <span class="bold"><strong>Exception Safety:</strong></span> If any exception
  1157. is thrown, the result of the expression <code class="computeroutput"><span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code> remains unchanged. If an exception
  1158. is thrown during the call to <code class="computeroutput"><span class="identifier">T</span></code>'s
  1159. constructor, no effect. If an exception is thrown during the call to
  1160. <code class="computeroutput"><span class="identifier">T</span></code>'s assignment, the
  1161. state of its contained value is as defined by the exception safety
  1162. guarantee of <code class="computeroutput"><span class="identifier">T</span></code>'s copy
  1163. assignment.
  1164. </li>
  1165. <li class="listitem">
  1166. <span class="bold"><strong>Example:</strong></span>
  1167. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  1168. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt0</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  1169. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">opt1</span><span class="special">;</span>
  1170. <span class="identifier">opt1</span> <span class="special">=</span> <span class="identifier">opt0</span> <span class="special">;</span>
  1171. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt1</span> <span class="special">==</span> <span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  1172. </pre>
  1173. </li>
  1174. </ul></div>
  1175. <p>
  1176. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1177. </p>
  1178. <a name="reference_optional_operator_move_equal_other_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1179. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">optional</span><span class="special">&amp;</span>
  1180. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;&amp;&amp;</span> <span class="identifier">rhs</span>
  1181. <span class="special">)</span> <span class="special">;</span></code>
  1182. </p></blockquote></div>
  1183. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1184. <li class="listitem">
  1185. <p class="simpara">
  1186. <span class="bold"><strong>Effect:</strong></span>
  1187. </p>
  1188. <div class="informaltable"><table class="table">
  1189. <colgroup>
  1190. <col>
  1191. <col>
  1192. <col>
  1193. </colgroup>
  1194. <thead><tr></tr></thead>
  1195. <tbody>
  1196. <tr>
  1197. <td>
  1198. </td>
  1199. <td>
  1200. <p>
  1201. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value</strong></span>
  1202. </p>
  1203. </td>
  1204. <td>
  1205. <p>
  1206. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value</strong></span>
  1207. </p>
  1208. </td>
  1209. </tr>
  1210. <tr>
  1211. <td>
  1212. <p>
  1213. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  1214. contains a value</strong></span>
  1215. </p>
  1216. </td>
  1217. <td>
  1218. <p>
  1219. assigns <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">rhs</span><span class="special">)</span></code> to the contained value
  1220. </p>
  1221. </td>
  1222. <td>
  1223. <p>
  1224. initializes the contained value as if direct-initializing
  1225. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  1226. with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">rhs</span><span class="special">)</span></code>
  1227. </p>
  1228. </td>
  1229. </tr>
  1230. <tr>
  1231. <td>
  1232. <p>
  1233. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  1234. does not contain a value</strong></span>
  1235. </p>
  1236. </td>
  1237. <td>
  1238. <p>
  1239. destroys the contained value by calling <code class="computeroutput"><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>
  1240. </p>
  1241. </td>
  1242. <td>
  1243. <p>
  1244. no effect
  1245. </p>
  1246. </td>
  1247. </tr>
  1248. </tbody>
  1249. </table></div>
  1250. </li>
  1251. <li class="listitem">
  1252. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
  1253. </li>
  1254. <li class="listitem">
  1255. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="keyword">bool</span><span class="special">(</span><span class="identifier">rhs</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code>.
  1256. </li>
  1257. <li class="listitem">
  1258. <span class="bold"><strong>Exception Safety:</strong></span> If any exception
  1259. is thrown, the result of the expression <code class="computeroutput"><span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span></code> remains unchanged. If an exception
  1260. is thrown during the call to <code class="computeroutput"><span class="identifier">T</span></code>'s
  1261. constructor, no effect. If an exception is thrown during the call to
  1262. <code class="computeroutput"><span class="identifier">T</span></code>'s assignment, the
  1263. state of its contained value is as defined by the exception safety
  1264. guarantee of <code class="computeroutput"><span class="identifier">T</span></code>'s copy
  1265. assignment.
  1266. </li>
  1267. <li class="listitem">
  1268. <span class="bold"><strong>Example:</strong></span>
  1269. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  1270. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt0</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  1271. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">opt1</span><span class="special">;</span>
  1272. <span class="identifier">opt1</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(</span><span class="identifier">opt0</span><span class="special">)</span> <span class="special">;</span>
  1273. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt0</span> <span class="special">);</span>
  1274. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt1</span> <span class="special">)</span>
  1275. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt1</span> <span class="special">==</span> <span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  1276. </pre>
  1277. </li>
  1278. </ul></div>
  1279. <p>
  1280. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1281. </p>
  1282. <a name="reference_optional_emplace"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1283. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">&gt;</span>
  1284. <span class="keyword">void</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1285. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">emplace</span><span class="special">(</span>
  1286. <span class="identifier">Args</span><span class="special">...&amp;&amp;</span>
  1287. <span class="identifier">args</span> <span class="special">);</span></code>
  1288. </p></blockquote></div>
  1289. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1290. <li class="listitem">
  1291. <span class="bold"><strong>Requires:</strong></span> The compiler supports rvalue
  1292. references and variadic templates.
  1293. </li>
  1294. <li class="listitem">
  1295. <span class="bold"><strong>Effect:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized calls <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span> <span class="special">=</span> <span class="identifier">none</span></code>.
  1296. Then initializes in-place the contained value as if direct-initializing
  1297. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  1298. with <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">forward</span><span class="special">&lt;</span><span class="identifier">Args</span><span class="special">&gt;(</span><span class="identifier">args</span><span class="special">)...</span></code>.
  1299. </li>
  1300. <li class="listitem">
  1301. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>.
  1302. </li>
  1303. <li class="listitem">
  1304. <span class="bold"><strong>Throws:</strong></span> Whatever the selected <code class="computeroutput"><span class="identifier">T</span></code>'s constructor throws.
  1305. </li>
  1306. <li class="listitem">
  1307. <span class="bold"><strong>Exception Safety:</strong></span> If an exception
  1308. is thrown during the initialization of <code class="computeroutput"><span class="identifier">T</span></code>,
  1309. <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  1310. is <span class="emphasis"><em>uninitialized</em></span>.
  1311. </li>
  1312. <li class="listitem">
  1313. <span class="bold"><strong>Notes:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  1314. need not be <code class="computeroutput"><span class="identifier">MoveConstructible</span></code>
  1315. or <code class="computeroutput"><span class="identifier">MoveAssignable</span></code>.
  1316. On compilers that do not support variadic templates, the signature
  1317. falls back to two overloads:<code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span>
  1318. <span class="identifier">Arg</span><span class="special">&gt;</span>
  1319. <span class="keyword">void</span> <span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Arg</span><span class="special">&amp;&amp;</span> <span class="identifier">arg</span><span class="special">)</span></code> and <code class="computeroutput"><span class="keyword">void</span>
  1320. <span class="identifier">emplace</span><span class="special">()</span></code>.
  1321. On compilers that do not support rvalue references, the signature falls
  1322. back to three overloads: taking <code class="computeroutput"><span class="keyword">const</span></code>
  1323. and non-<code class="computeroutput"><span class="keyword">const</span></code> lvalue reference,
  1324. and third with empty function argument list.
  1325. </li>
  1326. <li class="listitem">
  1327. <span class="bold"><strong>Example:</strong></span>
  1328. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  1329. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">;</span>
  1330. <span class="identifier">opt</span><span class="special">.</span><span class="identifier">emplace</span><span class="special">(</span><span class="number">0</span><span class="special">);</span> <span class="comment">// create in-place using ctor T(int)</span>
  1331. <span class="identifier">opt</span><span class="special">.</span><span class="identifier">emplace</span><span class="special">();</span> <span class="comment">// destroy previous and default-construct another T</span>
  1332. <span class="identifier">opt</span><span class="special">.</span><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span> <span class="comment">// destroy and copy-construct in-place (no assignment called)</span>
  1333. </pre>
  1334. </li>
  1335. </ul></div>
  1336. <p>
  1337. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1338. </p>
  1339. <a name="reference_optional_operator_equal_factory"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1340. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">InPlaceFactory</span><span class="special">&gt;</span>
  1341. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;</span>
  1342. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">InPlaceFactory</span>
  1343. <span class="keyword">const</span><span class="special">&amp;</span>
  1344. <span class="identifier">f</span> <span class="special">);</span></code>
  1345. </p></blockquote></div>
  1346. <div class="blockquote"><blockquote class="blockquote"><p>
  1347. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">TypedInPlaceFactory</span><span class="special">&gt;</span>
  1348. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;</span>
  1349. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">=(</span> <span class="identifier">TypedInPlaceFactory</span>
  1350. <span class="keyword">const</span><span class="special">&amp;</span>
  1351. <span class="identifier">f</span> <span class="special">);</span></code>
  1352. </p></blockquote></div>
  1353. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1354. <li class="listitem">
  1355. <span class="bold"><strong>Effect:</strong></span> Assigns an <code class="computeroutput"><span class="identifier">optional</span></code>
  1356. with a value of <code class="computeroutput"><span class="identifier">T</span></code> obtained
  1357. from the factory.
  1358. </li>
  1359. <li class="listitem">
  1360. <span class="bold"><strong>Postconditions: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is <span class="underline">initialized</span>
  1361. and its value is <span class="emphasis"><em>directly given</em></span> from the factory
  1362. <code class="computeroutput"><span class="identifier">f</span></code> (i.e., the value
  1363. <span class="underline">is not copied</span>).
  1364. </li>
  1365. <li class="listitem">
  1366. <span class="bold"><strong>Throws:</strong></span> Whatever the <code class="computeroutput"><span class="identifier">T</span></code> constructor called by the factory
  1367. throws.
  1368. </li>
  1369. <li class="listitem">
  1370. <span class="bold"><strong>Notes:</strong></span> See <a class="link" href="../../tutorial/in_place_factories.html" title="In-Place Factories">In-Place
  1371. Factories</a>
  1372. </li>
  1373. <li class="listitem">
  1374. <span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
  1375. be thrown during the call to the <code class="computeroutput"><span class="identifier">T</span></code>
  1376. constructor used by the factory; in that case, the <code class="computeroutput"><span class="identifier">optional</span></code>
  1377. object will be reset to be <span class="emphasis"><em>uninitialized</em></span>.
  1378. </li>
  1379. </ul></div>
  1380. <p>
  1381. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1382. </p>
  1383. <a name="reference_optional_reset_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1384. <code class="computeroutput"><span class="keyword">void</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1385. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">reset</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span></code>
  1386. </p></blockquote></div>
  1387. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  1388. <span class="bold"><strong>Deprecated:</strong></span> same as <code class="computeroutput"><span class="keyword">operator</span><span class="special">=</span>
  1389. <span class="special">(</span> <span class="identifier">T</span>
  1390. <span class="keyword">const</span><span class="special">&amp;</span>
  1391. <span class="identifier">v</span><span class="special">)</span>
  1392. <span class="special">;</span></code>
  1393. </li></ul></div>
  1394. <p>
  1395. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1396. </p>
  1397. <a name="reference_optional_reset"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1398. <code class="computeroutput"><span class="keyword">void</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">reset</span><span class="special">()</span> <span class="keyword">noexcept</span>
  1399. <span class="special">;</span></code>
  1400. </p></blockquote></div>
  1401. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  1402. <span class="bold"><strong>Deprecated:</strong></span> Same as <code class="computeroutput"><span class="keyword">operator</span><span class="special">=(</span>
  1403. <span class="identifier">none_t</span> <span class="special">);</span></code>
  1404. </li></ul></div>
  1405. <p>
  1406. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1407. </p>
  1408. <a name="reference_optional_get"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1409. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1410. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span> <span class="special">;</span></code>
  1411. </p></blockquote></div>
  1412. <div class="blockquote"><blockquote class="blockquote"><p>
  1413. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
  1414. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get</span><span class="special">()</span> <span class="special">;</span></code>
  1415. </p></blockquote></div>
  1416. <div class="blockquote"><blockquote class="blockquote"><p>
  1417. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span>
  1418. <span class="keyword">const</span><span class="special">&amp;</span>
  1419. <span class="identifier">get</span> <span class="special">(</span>
  1420. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="special">)</span> <span class="special">;</span></code>
  1421. </p></blockquote></div>
  1422. <div class="blockquote"><blockquote class="blockquote"><p>
  1423. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">get</span>
  1424. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1425. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span>
  1426. <span class="special">&amp;)</span> <span class="special">;</span></code>
  1427. </p></blockquote></div>
  1428. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1429. <li class="listitem">
  1430. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized
  1431. </li>
  1432. <li class="listitem">
  1433. <span class="bold"><strong>Returns:</strong></span> A reference to the contained
  1434. value
  1435. </li>
  1436. <li class="listitem">
  1437. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1438. </li>
  1439. <li class="listitem">
  1440. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1441. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1442. </li>
  1443. </ul></div>
  1444. <p>
  1445. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1446. </p>
  1447. <div class="blockquote"><blockquote class="blockquote"><p>
  1448. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span> <span class="special">;</span></code>
  1449. </p></blockquote></div>
  1450. <div class="blockquote"><blockquote class="blockquote"><p>
  1451. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
  1452. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="identifier">get</span><span class="special">()</span> <span class="special">;</span></code>
  1453. </p></blockquote></div>
  1454. <div class="blockquote"><blockquote class="blockquote"><p>
  1455. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span>
  1456. <span class="keyword">const</span><span class="special">&amp;</span>
  1457. <span class="identifier">get</span> <span class="special">(</span>
  1458. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span>
  1459. <span class="keyword">const</span><span class="special">&amp;</span>
  1460. <span class="special">)</span> <span class="special">;</span></code>
  1461. </p></blockquote></div>
  1462. <div class="blockquote"><blockquote class="blockquote"><p>
  1463. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">get</span>
  1464. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="special">&amp;)</span>
  1465. <span class="special">;</span></code>
  1466. </p></blockquote></div>
  1467. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1468. <li class="listitem">
  1469. <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized
  1470. </li>
  1471. <li class="listitem">
  1472. <span class="bold"><strong>Returns:</strong></span> <span class="underline">The</span>
  1473. reference contained.
  1474. </li>
  1475. <li class="listitem">
  1476. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1477. </li>
  1478. <li class="listitem">
  1479. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1480. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1481. </li>
  1482. </ul></div>
  1483. <p>
  1484. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1485. </p>
  1486. <a name="reference_optional_operator_asterisk"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1487. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1488. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">*()</span>
  1489. <span class="keyword">const</span><span class="special">&amp;</span>
  1490. <span class="special">;</span></code>
  1491. </p></blockquote></div>
  1492. <div class="blockquote"><blockquote class="blockquote"><p>
  1493. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
  1494. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">*()</span> <span class="special">&amp;;</span></code>
  1495. </p></blockquote></div>
  1496. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1497. <li class="listitem">
  1498. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized
  1499. </li>
  1500. <li class="listitem">
  1501. <span class="bold"><strong>Returns:</strong></span> A reference to the contained
  1502. value
  1503. </li>
  1504. <li class="listitem">
  1505. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1506. </li>
  1507. <li class="listitem">
  1508. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1509. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1510. On compilers that do not support ref-qualifiers on member functions
  1511. these two overloads are replaced with the classical two: a <code class="computeroutput"><span class="keyword">const</span></code> and non-<code class="computeroutput"><span class="keyword">const</span></code>
  1512. member functions.
  1513. </li>
  1514. <li class="listitem">
  1515. <span class="bold"><strong>Example:</strong></span>
  1516. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span> <span class="special">;</span>
  1517. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span> <span class="special">(</span> <span class="identifier">v</span> <span class="special">);</span>
  1518. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="special">*</span><span class="identifier">opt</span><span class="special">;</span>
  1519. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">u</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  1520. <span class="identifier">T</span> <span class="identifier">w</span> <span class="special">;</span>
  1521. <span class="special">*</span><span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">w</span> <span class="special">;</span>
  1522. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">w</span> <span class="special">)</span> <span class="special">;</span>
  1523. </pre>
  1524. </li>
  1525. </ul></div>
  1526. <p>
  1527. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1528. </p>
  1529. <a name="reference_optional_operator_asterisk_move"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1530. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;&amp;</span>
  1531. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">*()</span> <span class="special">&amp;&amp;;</span></code>
  1532. </p></blockquote></div>
  1533. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1534. <li class="listitem">
  1535. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value.
  1536. </li>
  1537. <li class="listitem">
  1538. <span class="bold"><strong>Effects:</strong></span> Equivalent to <code class="computeroutput"><span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">val</span><span class="special">);</span></code>.
  1539. </li>
  1540. <li class="listitem">
  1541. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1542. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1543. On compilers that do not support ref-qualifiers on member functions
  1544. this overload is not present.
  1545. </li>
  1546. </ul></div>
  1547. <p>
  1548. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1549. </p>
  1550. <div class="blockquote"><blockquote class="blockquote"><p>
  1551. <code class="computeroutput"><span class="identifier">T</span> <span class="special">&amp;</span>
  1552. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">*()</span>
  1553. <span class="keyword">const</span><span class="special">&amp;</span>
  1554. <span class="special">;</span></code>
  1555. </p></blockquote></div>
  1556. <div class="blockquote"><blockquote class="blockquote"><p>
  1557. <code class="computeroutput"><span class="identifier">T</span> <span class="special">&amp;</span>
  1558. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">*()</span>
  1559. <span class="special">&amp;</span> <span class="special">;</span></code>
  1560. </p></blockquote></div>
  1561. <div class="blockquote"><blockquote class="blockquote"><p>
  1562. <code class="computeroutput"><span class="identifier">T</span> <span class="special">&amp;</span>
  1563. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;::</span><span class="keyword">operator</span><span class="special">*()</span>
  1564. <span class="special">&amp;&amp;</span> <span class="special">;</span></code>
  1565. </p></blockquote></div>
  1566. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1567. <li class="listitem">
  1568. <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized
  1569. </li>
  1570. <li class="listitem">
  1571. <span class="bold"><strong>Returns:</strong></span> <span class="underline">The</span>
  1572. reference contained.
  1573. </li>
  1574. <li class="listitem">
  1575. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1576. </li>
  1577. <li class="listitem">
  1578. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1579. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1580. On compilers that do not support ref-qualifiers on member functions
  1581. these three overloads are replaced with the classical two: a <code class="computeroutput"><span class="keyword">const</span></code> and non-<code class="computeroutput"><span class="keyword">const</span></code>
  1582. member functions.
  1583. </li>
  1584. <li class="listitem">
  1585. <span class="bold"><strong>Example:</strong></span>
  1586. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span> <span class="special">;</span>
  1587. <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">vref</span> <span class="special">=</span> <span class="identifier">v</span> <span class="special">;</span>
  1588. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">opt</span> <span class="special">(</span> <span class="identifier">vref</span> <span class="special">);</span>
  1589. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">vref2</span> <span class="special">=</span> <span class="special">*</span><span class="identifier">opt</span><span class="special">;</span>
  1590. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">vref2</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  1591. <span class="special">++</span> <span class="identifier">v</span> <span class="special">;</span>
  1592. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">opt</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  1593. </pre>
  1594. </li>
  1595. </ul></div>
  1596. <p>
  1597. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1598. </p>
  1599. <a name="reference_optional_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1600. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">()</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="special">;</span></code>
  1601. </p></blockquote></div>
  1602. <div class="blockquote"><blockquote class="blockquote"><p>
  1603. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
  1604. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">()</span> <span class="special">&amp;</span> <span class="special">;</span></code>
  1605. </p></blockquote></div>
  1606. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1607. <li class="listitem">
  1608. <span class="bold"><strong>Effects:</strong></span> Equivalent to <code class="computeroutput"><span class="keyword">return</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="special">?</span> <span class="special">*</span><span class="identifier">val</span> <span class="special">:</span> <span class="keyword">throw</span> <span class="identifier">bad_optional_access</span><span class="special">();</span></code>.
  1609. </li>
  1610. <li class="listitem">
  1611. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1612. ref-qualifiers on member functions these two overloads are replaced
  1613. with the classical two: a <code class="computeroutput"><span class="keyword">const</span></code>
  1614. and non-<code class="computeroutput"><span class="keyword">const</span></code> member functions.
  1615. </li>
  1616. <li class="listitem">
  1617. <span class="bold"><strong>Example:</strong></span>
  1618. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span> <span class="special">;</span>
  1619. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">o0</span><span class="special">,</span> <span class="identifier">o1</span> <span class="special">(</span> <span class="identifier">v</span> <span class="special">);</span>
  1620. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">o1</span><span class="special">.</span><span class="identifier">value</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">);</span>
  1621. <span class="keyword">try</span> <span class="special">{</span>
  1622. <span class="identifier">o0</span><span class="special">.</span><span class="identifier">value</span><span class="special">();</span> <span class="comment">// throws</span>
  1623. <span class="identifier">assert</span> <span class="special">(</span> <span class="keyword">false</span> <span class="special">);</span>
  1624. <span class="special">}</span>
  1625. <span class="keyword">catch</span><span class="special">(</span><span class="identifier">bad_optional_access</span><span class="special">&amp;)</span> <span class="special">{</span>
  1626. <span class="identifier">assert</span> <span class="special">(</span> <span class="keyword">true</span> <span class="special">);</span>
  1627. <span class="special">}</span>
  1628. </pre>
  1629. </li>
  1630. </ul></div>
  1631. <p>
  1632. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1633. </p>
  1634. <a name="reference_optional_value_move"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1635. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;&amp;</span>
  1636. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value</span><span class="special">()</span> <span class="special">&amp;&amp;</span> <span class="special">;</span></code>
  1637. </p></blockquote></div>
  1638. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1639. <li class="listitem">
  1640. <span class="bold"><strong>Effects:</strong></span> Equivalent to <code class="computeroutput"><span class="keyword">return</span> <span class="keyword">bool</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="special">?</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">val</span><span class="special">)</span> <span class="special">:</span> <span class="keyword">throw</span> <span class="identifier">bad_optional_access</span><span class="special">();</span></code>.
  1641. </li>
  1642. <li class="listitem">
  1643. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1644. ref-qualifiers on member functions this overload is not present.
  1645. </li>
  1646. </ul></div>
  1647. <p>
  1648. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1649. </p>
  1650. <a name="reference_optional_value_or"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1651. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value_or</span><span class="special">(</span><span class="identifier">U</span> <span class="special">&amp;&amp;</span>
  1652. <span class="identifier">v</span><span class="special">)</span>
  1653. <span class="keyword">const</span><span class="special">&amp;</span>
  1654. <span class="special">;</span></code>
  1655. </p></blockquote></div>
  1656. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1657. <li class="listitem">
  1658. <span class="bold"><strong>Effects:</strong></span> Equivalent to <code class="computeroutput"><span class="keyword">if</span> <span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="keyword">return</span> <span class="special">**</span><span class="keyword">this</span><span class="special">;</span> <span class="keyword">else</span> <span class="keyword">return</span>
  1659. <span class="identifier">std</span><span class="special">::</span><span class="identifier">forward</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">);</span></code>.
  1660. </li>
  1661. <li class="listitem">
  1662. <span class="bold"><strong>Remarks:</strong></span> If <code class="computeroutput"><span class="identifier">T</span></code>
  1663. is not <a href="../../../../../../utility/CopyConstructible.html" target="_top"><code class="computeroutput"><span class="identifier">CopyConstructible</span></code></a> or <code class="computeroutput"><span class="identifier">U</span> <span class="special">&amp;&amp;</span></code>
  1664. is not convertible to <code class="computeroutput"><span class="identifier">T</span></code>,
  1665. the program is ill-formed.
  1666. </li>
  1667. <li class="listitem">
  1668. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1669. ref-qualifiers on member functions this overload is replaced with the
  1670. <code class="computeroutput"><span class="keyword">const</span></code>-qualified member
  1671. function. On compilers without rvalue reference support the type of
  1672. <code class="computeroutput"><span class="identifier">v</span></code> becomes <code class="computeroutput"><span class="identifier">U</span> <span class="keyword">const</span><span class="special">&amp;</span></code>.
  1673. </li>
  1674. </ul></div>
  1675. <p>
  1676. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1677. </p>
  1678. <a name="reference_optional_value_or_move"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1679. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">U</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value_or</span><span class="special">(</span><span class="identifier">U</span> <span class="special">&amp;&amp;</span>
  1680. <span class="identifier">v</span><span class="special">)</span>
  1681. <span class="special">&amp;&amp;</span> <span class="special">;</span></code>
  1682. </p></blockquote></div>
  1683. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1684. <li class="listitem">
  1685. <span class="bold"><strong>Effects:</strong></span> Equivalent to <code class="computeroutput"><span class="keyword">if</span> <span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(**</span><span class="keyword">this</span><span class="special">);</span> <span class="keyword">else</span> <span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">forward</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">);</span></code>.
  1686. </li>
  1687. <li class="listitem">
  1688. <span class="bold"><strong>Remarks:</strong></span> If <code class="computeroutput"><span class="identifier">T</span></code>
  1689. is not <code class="computeroutput"><span class="identifier">MoveConstructible</span></code>
  1690. or <code class="computeroutput"><span class="identifier">U</span> <span class="special">&amp;&amp;</span></code>
  1691. is not convertible to <code class="computeroutput"><span class="identifier">T</span></code>,
  1692. the program is ill-formed.
  1693. </li>
  1694. <li class="listitem">
  1695. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1696. ref-qualifiers on member functions this overload is not present.
  1697. </li>
  1698. </ul></div>
  1699. <p>
  1700. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1701. </p>
  1702. <a name="reference_optional_value_or_call"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1703. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">F</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value_or_eval</span><span class="special">(</span><span class="identifier">F</span> <span class="identifier">f</span><span class="special">)</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="special">;</span></code>
  1704. </p></blockquote></div>
  1705. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1706. <li class="listitem">
  1707. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  1708. is <a href="../../../../../../utility/CopyConstructible.html" target="_top"><code class="computeroutput"><span class="identifier">CopyConstructible</span></code></a> and <code class="computeroutput"><span class="identifier">F</span></code> models a <a href="http://www.sgi.com/tech/stl/Generator.html" target="_top"><code class="computeroutput"><span class="identifier">Generator</span></code></a> whose result type
  1709. is convertible to <code class="computeroutput"><span class="identifier">T</span></code>.
  1710. </li>
  1711. <li class="listitem">
  1712. <span class="bold"><strong>Effects:</strong></span> <code class="computeroutput"><span class="keyword">if</span>
  1713. <span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="keyword">return</span> <span class="special">**</span><span class="keyword">this</span><span class="special">;</span> <span class="keyword">else</span> <span class="keyword">return</span> <span class="identifier">f</span><span class="special">();</span></code>.
  1714. </li>
  1715. <li class="listitem">
  1716. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1717. ref-qualifiers on member functions this overload is replaced with the
  1718. <code class="computeroutput"><span class="keyword">const</span></code>-qualified member
  1719. function.
  1720. </li>
  1721. <li class="listitem">
  1722. <span class="bold"><strong>Example:</strong></span>
  1723. <pre class="programlisting"><span class="keyword">int</span> <span class="identifier">complain_and_0</span><span class="special">()</span>
  1724. <span class="special">{</span>
  1725. <span class="identifier">clog</span> <span class="special">&lt;&lt;</span> <span class="string">"no value returned, using default"</span> <span class="special">&lt;&lt;</span> <span class="identifier">endl</span><span class="special">;</span>
  1726. <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
  1727. <span class="special">}</span>
  1728. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">o1</span> <span class="special">=</span> <span class="number">1</span><span class="special">;</span>
  1729. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">oN</span> <span class="special">=</span> <span class="identifier">none</span><span class="special">;</span>
  1730. <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">o1</span><span class="special">.</span><span class="identifier">value_or_eval</span><span class="special">(</span><span class="identifier">complain_and_0</span><span class="special">);</span> <span class="comment">// fun not called</span>
  1731. <span class="identifier">assert</span> <span class="special">(</span><span class="identifier">i</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
  1732. <span class="keyword">int</span> <span class="identifier">j</span> <span class="special">=</span> <span class="identifier">oN</span><span class="special">.</span><span class="identifier">value_or_eval</span><span class="special">(</span><span class="identifier">complain_and_0</span><span class="special">);</span> <span class="comment">// fun called</span>
  1733. <span class="identifier">assert</span> <span class="special">(</span><span class="identifier">i</span> <span class="special">==</span> <span class="number">0</span><span class="special">);</span>
  1734. </pre>
  1735. </li>
  1736. </ul></div>
  1737. <p>
  1738. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1739. </p>
  1740. <a name="reference_optional_value_or_call_move"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1741. <code class="computeroutput"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">F</span><span class="special">&gt;</span> <span class="identifier">T</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">value_or_eval</span><span class="special">(</span><span class="identifier">F</span> <span class="identifier">f</span><span class="special">)</span> <span class="special">&amp;&amp;</span>
  1742. <span class="special">;</span></code>
  1743. </p></blockquote></div>
  1744. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1745. <li class="listitem">
  1746. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  1747. is <code class="computeroutput"><span class="identifier">MoveConstructible</span></code>
  1748. and <code class="computeroutput"><span class="identifier">F</span></code> models a <a href="http://www.sgi.com/tech/stl/Generator.html" target="_top"><code class="computeroutput"><span class="identifier">Generator</span></code></a>
  1749. whose result type is convertible to <code class="computeroutput"><span class="identifier">T</span></code>.
  1750. </li>
  1751. <li class="listitem">
  1752. <span class="bold"><strong>Effects:</strong></span> <code class="computeroutput"><span class="keyword">if</span>
  1753. <span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(**</span><span class="keyword">this</span><span class="special">);</span> <span class="keyword">else</span> <span class="keyword">return</span>
  1754. <span class="identifier">f</span><span class="special">();</span></code>.
  1755. </li>
  1756. <li class="listitem">
  1757. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1758. ref-qualifiers on member functions this overload is not present.
  1759. </li>
  1760. </ul></div>
  1761. <p>
  1762. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1763. </p>
  1764. <a name="reference_optional_get_value_or_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1765. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1766. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get_value_or</span><span class="special">(</span>
  1767. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">default</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">;</span></code>
  1768. </p></blockquote></div>
  1769. <div class="blockquote"><blockquote class="blockquote"><p>
  1770. <code class="computeroutput"><span class="identifier">T</span><span class="special">&amp;</span>
  1771. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get_value_or</span><span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="keyword">default</span>
  1772. <span class="special">)</span> <span class="special">;</span></code>
  1773. </p></blockquote></div>
  1774. <div class="blockquote"><blockquote class="blockquote"><p>
  1775. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span>
  1776. <span class="keyword">const</span><span class="special">&amp;</span>
  1777. <span class="identifier">get_optional_value_or</span> <span class="special">(</span>
  1778. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">o</span><span class="special">,</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">default</span> <span class="special">)</span> <span class="special">;</span></code>
  1779. </p></blockquote></div>
  1780. <div class="blockquote"><blockquote class="blockquote"><p>
  1781. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">get_optional_value_or</span>
  1782. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1783. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;&amp;</span>
  1784. <span class="identifier">o</span><span class="special">,</span>
  1785. <span class="identifier">T</span><span class="special">&amp;</span>
  1786. <span class="keyword">default</span> <span class="special">)</span>
  1787. <span class="special">;</span></code>
  1788. </p></blockquote></div>
  1789. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1790. <li class="listitem">
  1791. <span class="bold"><strong>Deprecated:</strong></span> Use <code class="computeroutput"><span class="identifier">value_or</span><span class="special">()</span></code> instead.
  1792. </li>
  1793. <li class="listitem">
  1794. <span class="bold"><strong>Returns:</strong></span> A reference to the contained
  1795. value, if any, or <code class="computeroutput"><span class="keyword">default</span></code>.
  1796. </li>
  1797. <li class="listitem">
  1798. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1799. </li>
  1800. <li class="listitem">
  1801. <span class="bold"><strong>Example:</strong></span>
  1802. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">,</span> <span class="identifier">z</span> <span class="special">;</span>
  1803. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span><span class="special">;</span>
  1804. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">=</span> <span class="identifier">def</span><span class="special">.</span><span class="identifier">get_value_or</span><span class="special">(</span><span class="identifier">z</span><span class="special">);</span>
  1805. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">y</span> <span class="special">==</span> <span class="identifier">z</span> <span class="special">)</span> <span class="special">;</span>
  1806. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span> <span class="special">(</span> <span class="identifier">v</span> <span class="special">);</span>
  1807. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">get_optional_value_or</span><span class="special">(</span><span class="identifier">opt</span><span class="special">,</span><span class="identifier">z</span><span class="special">);</span>
  1808. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">u</span> <span class="special">==</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  1809. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">u</span> <span class="special">!=</span> <span class="identifier">z</span> <span class="special">)</span> <span class="special">;</span>
  1810. </pre>
  1811. </li>
  1812. </ul></div>
  1813. <p>
  1814. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1815. </p>
  1816. <a name="reference_optional_get_ptr"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1817. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1818. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get_ptr</span><span class="special">()</span>
  1819. <span class="keyword">const</span> <span class="special">;</span></code>
  1820. </p></blockquote></div>
  1821. <div class="blockquote"><blockquote class="blockquote"><p>
  1822. <code class="computeroutput"><span class="identifier">T</span><span class="special">*</span>
  1823. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="identifier">get_ptr</span><span class="special">()</span> <span class="special">;</span></code>
  1824. </p></blockquote></div>
  1825. <div class="blockquote"><blockquote class="blockquote"><p>
  1826. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span>
  1827. <span class="keyword">const</span><span class="special">*</span>
  1828. <span class="identifier">get_pointer</span> <span class="special">(</span>
  1829. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="special">)</span> <span class="special">;</span></code>
  1830. </p></blockquote></div>
  1831. <div class="blockquote"><blockquote class="blockquote"><p>
  1832. <code class="computeroutput"><span class="keyword">inline</span> <span class="identifier">T</span><span class="special">*</span> <span class="identifier">get_pointer</span>
  1833. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1834. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span>
  1835. <span class="special">&amp;)</span> <span class="special">;</span></code>
  1836. </p></blockquote></div>
  1837. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1838. <li class="listitem">
  1839. <span class="bold"><strong>Returns:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized, a pointer to the
  1840. contained value; else <code class="computeroutput"><span class="number">0</span></code>
  1841. (<span class="emphasis"><em>null</em></span>).
  1842. </li>
  1843. <li class="listitem">
  1844. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1845. </li>
  1846. <li class="listitem">
  1847. <span class="bold"><strong>Notes:</strong></span> The contained value is permanently
  1848. stored within <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>,
  1849. so you should not hold nor delete this pointer
  1850. </li>
  1851. <li class="listitem">
  1852. <span class="bold"><strong>Example:</strong></span>
  1853. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">v</span><span class="special">;</span>
  1854. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  1855. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">copt</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  1856. <span class="identifier">T</span><span class="special">*</span> <span class="identifier">p</span> <span class="special">=</span> <span class="identifier">opt</span><span class="special">.</span><span class="identifier">get_ptr</span><span class="special">()</span> <span class="special">;</span>
  1857. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">cp</span> <span class="special">=</span> <span class="identifier">copt</span><span class="special">.</span><span class="identifier">get_ptr</span><span class="special">();</span>
  1858. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">p</span> <span class="special">==</span> <span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">opt</span><span class="special">)</span> <span class="special">);</span>
  1859. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">cp</span> <span class="special">==</span> <span class="identifier">get_pointer</span><span class="special">(</span><span class="identifier">copt</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  1860. </pre>
  1861. </li>
  1862. </ul></div>
  1863. <p>
  1864. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1865. </p>
  1866. <a name="reference_optional_operator_arrow"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1867. <code class="computeroutput"><span class="identifier">T</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code>
  1868. <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span> <span class="special">-&gt;()</span>
  1869. <span class="keyword">const</span> <span class="special">;</span></code>
  1870. </p></blockquote></div>
  1871. <div class="blockquote"><blockquote class="blockquote"><p>
  1872. <code class="computeroutput"><span class="identifier">T</span><span class="special">*</span>
  1873. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;::</span><span class="keyword">operator</span>
  1874. <span class="special">-&gt;()</span> <span class="special">;</span></code>
  1875. </p></blockquote></div>
  1876. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1877. <li class="listitem">
  1878. <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is initialized.
  1879. </li>
  1880. <li class="listitem">
  1881. <span class="bold"><strong>Returns:</strong></span> A pointer to the contained
  1882. value.
  1883. </li>
  1884. <li class="listitem">
  1885. <span class="bold"><strong>Throws:</strong></span> Nothing.
  1886. </li>
  1887. <li class="listitem">
  1888. <span class="bold"><strong>Notes:</strong></span> The requirement is asserted
  1889. via <code class="computeroutput"><span class="identifier">BOOST_ASSERT</span><span class="special">()</span></code>.
  1890. </li>
  1891. <li class="listitem">
  1892. <span class="bold"><strong>Example:</strong></span>
  1893. <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">X</span> <span class="special">{</span> <span class="keyword">int</span> <span class="identifier">mdata</span> <span class="special">;</span> <span class="special">}</span> <span class="special">;</span>
  1894. <span class="identifier">X</span> <span class="identifier">x</span> <span class="special">;</span>
  1895. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">X</span><span class="special">&gt;</span> <span class="identifier">opt</span> <span class="special">(</span><span class="identifier">x</span><span class="special">);</span>
  1896. <span class="identifier">opt</span><span class="special">-&gt;</span><span class="identifier">mdata</span> <span class="special">=</span> <span class="number">2</span> <span class="special">;</span>
  1897. </pre>
  1898. </li>
  1899. </ul></div>
  1900. <p>
  1901. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1902. </p>
  1903. <a name="reference_optional_operator_bool"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1904. <code class="computeroutput"><span class="keyword">explicit</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="keyword">operator</span>
  1905. <span class="keyword">bool</span><span class="special">()</span>
  1906. <span class="keyword">const</span> <span class="keyword">noexcept</span>
  1907. <span class="special">;</span></code>
  1908. </p></blockquote></div>
  1909. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1910. <li class="listitem">
  1911. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="identifier">get_ptr</span><span class="special">()</span> <span class="special">!=</span> <span class="number">0</span></code>.
  1912. </li>
  1913. <li class="listitem">
  1914. <span class="bold"><strong>Notes:</strong></span> On compilers that do not support
  1915. explicit conversion operators this falls back to safe-bool idiom.
  1916. </li>
  1917. <li class="listitem">
  1918. <span class="bold"><strong>Example:</strong></span>
  1919. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def</span> <span class="special">;</span>
  1920. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">def</span> <span class="special">==</span> <span class="number">0</span> <span class="special">);</span>
  1921. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span> <span class="special">(</span> <span class="identifier">v</span> <span class="special">)</span> <span class="special">;</span>
  1922. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt</span> <span class="special">);</span>
  1923. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt</span> <span class="special">!=</span> <span class="number">0</span> <span class="special">);</span>
  1924. </pre>
  1925. </li>
  1926. </ul></div>
  1927. <p>
  1928. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1929. </p>
  1930. <a name="reference_optional_operator_not"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1931. <code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">noexcept</span>
  1932. <span class="special">;</span></code>
  1933. </p></blockquote></div>
  1934. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1935. <li class="listitem">
  1936. <span class="bold"><strong>Returns:</strong></span> If <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> is uninitialized, <code class="computeroutput"><span class="keyword">true</span></code>; else <code class="computeroutput"><span class="keyword">false</span></code>.
  1937. </li>
  1938. <li class="listitem">
  1939. <span class="bold"><strong>Notes:</strong></span> This operator is provided for
  1940. those compilers which can't use the <span class="emphasis"><em>unspecified-bool-type
  1941. operator</em></span> in certain boolean contexts.
  1942. </li>
  1943. <li class="listitem">
  1944. <span class="bold"><strong>Example:</strong></span>
  1945. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">opt</span> <span class="special">;</span>
  1946. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">opt</span> <span class="special">);</span>
  1947. <span class="special">*</span><span class="identifier">opt</span> <span class="special">=</span> <span class="identifier">some_T</span> <span class="special">;</span>
  1948. <span class="comment">// Notice the "double-bang" idiom here.</span>
  1949. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!!</span><span class="identifier">opt</span> <span class="special">)</span> <span class="special">;</span>
  1950. </pre>
  1951. </li>
  1952. </ul></div>
  1953. <p>
  1954. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1955. </p>
  1956. <a name="reference_optional_is_initialized"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1957. <code class="computeroutput"><span class="keyword">bool</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">is_initialized</span><span class="special">()</span> <span class="keyword">const</span> <span class="special">;</span></code>
  1958. </p></blockquote></div>
  1959. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  1960. <span class="bold"><strong>Deprecated:</strong></span> Same as <code class="computeroutput"><span class="keyword">explicit</span> <span class="keyword">operator</span>
  1961. <span class="keyword">bool</span> <span class="special">()</span>
  1962. <span class="special">;</span></code>
  1963. </li></ul></div>
  1964. <p>
  1965. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1966. </p>
  1967. <h6>
  1968. <a name="boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.h1"></a>
  1969. <span class="phrase"><a name="boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.free_functions"></a></span><a class="link" href="detailed_semantics.html#boost_optional.reference.header__boost_optional_optional_hpp_.detailed_semantics.free_functions">Free
  1970. functions</a>
  1971. </h6>
  1972. <p>
  1973. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1974. </p>
  1975. <a name="reference_make_optional_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1976. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span> <span class="identifier">make_optional</span><span class="special">(</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span></code>
  1977. </p></blockquote></div>
  1978. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1979. <li class="listitem">
  1980. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span></code> for the <span class="emphasis"><em>deduced</em></span>
  1981. type <code class="computeroutput"><span class="identifier">T</span></code> of <code class="computeroutput"><span class="identifier">v</span></code>.
  1982. </li>
  1983. <li class="listitem">
  1984. <span class="bold"><strong>Example:</strong></span>
  1985. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">void</span> <span class="identifier">foo</span> <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">opt</span> <span class="special">)</span> <span class="special">;</span>
  1986. <span class="identifier">foo</span> <span class="special">(</span> <span class="identifier">make_optional</span><span class="special">(</span><span class="number">1</span><span class="special">+</span><span class="number">1</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span> <span class="comment">// Creates an optional&lt;int&gt;</span>
  1987. </pre>
  1988. </li>
  1989. </ul></div>
  1990. <p>
  1991. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  1992. </p>
  1993. <a name="reference_make_optional_bool_value"></a><div class="blockquote"><blockquote class="blockquote"><p>
  1994. <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span></code> <span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">&gt;</span> <span class="identifier">make_optional</span><span class="special">(</span> <span class="keyword">bool</span> <span class="identifier">condition</span><span class="special">,</span>
  1995. <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">)</span></code>
  1996. </p></blockquote></div>
  1997. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  1998. <li class="listitem">
  1999. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;(</span><span class="identifier">condition</span><span class="special">,</span><span class="identifier">v</span><span class="special">)</span></code> for the <span class="emphasis"><em>deduced</em></span>
  2000. type <code class="computeroutput"><span class="identifier">T</span></code> of <code class="computeroutput"><span class="identifier">v</span></code>.
  2001. </li>
  2002. <li class="listitem">
  2003. <span class="bold"><strong>Example:</strong></span>
  2004. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">calculate_foo</span><span class="special">()</span>
  2005. <span class="special">{</span>
  2006. <span class="keyword">double</span> <span class="identifier">val</span> <span class="special">=</span> <span class="identifier">compute_foo</span><span class="special">();</span>
  2007. <span class="keyword">return</span> <span class="identifier">make_optional</span><span class="special">(</span><span class="identifier">is_not_nan_and_finite</span><span class="special">(</span><span class="identifier">val</span><span class="special">),</span><span class="identifier">val</span><span class="special">);</span>
  2008. <span class="special">}</span>
  2009. <span class="identifier">optional</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">calculate_foo</span><span class="special">();</span>
  2010. <span class="keyword">if</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">v</span> <span class="special">)</span>
  2011. <span class="identifier">error</span><span class="special">(</span><span class="string">"foo wasn't computed"</span><span class="special">);</span>
  2012. </pre>
  2013. </li>
  2014. </ul></div>
  2015. <p>
  2016. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2017. </p>
  2018. <a name="reference_operator_compare_equal_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2019. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2020. <span class="special">==</span> <span class="special">(</span>
  2021. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2022. </p></blockquote></div>
  2023. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  2024. <li class="listitem">
  2025. <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  2026. shall meet requirements of <a href="http://www.sgi.com/tech/stl/EqualityComparable.html" target="_top"><code class="computeroutput"><span class="identifier">EqualityComparable</span></code></a>.
  2027. </li>
  2028. <li class="listitem">
  2029. <span class="bold"><strong>Returns:</strong></span> If both <code class="computeroutput"><span class="identifier">x</span></code>
  2030. and <code class="computeroutput"><span class="identifier">y</span></code> are initialized,
  2031. <code class="computeroutput"><span class="special">(*</span><span class="identifier">x</span>
  2032. <span class="special">==</span> <span class="special">*</span><span class="identifier">y</span><span class="special">)</span></code>.
  2033. If only <code class="computeroutput"><span class="identifier">x</span></code> or <code class="computeroutput"><span class="identifier">y</span></code> is initialized, <code class="computeroutput"><span class="keyword">false</span></code>.
  2034. If both are uninitialized, <code class="computeroutput"><span class="keyword">true</span></code>.
  2035. </li>
  2036. <li class="listitem">
  2037. <span class="bold"><strong>Notes:</strong></span> This definition guarantees
  2038. that <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code>
  2039. not containing a value is compared unequal to any <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> containing any value, and equal
  2040. to any other <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> not containing a value. Pointers
  2041. have shallow relational operators while <code class="computeroutput"><span class="identifier">optional</span></code>
  2042. has deep relational operators. Do not use <code class="computeroutput"><span class="keyword">operator</span><span class="special">==</span></code> directly in generic code which expect
  2043. to be given either an <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> or a pointer; use <a href="../../../../../../utility/OptionalPointee.html#equal" target="_top"><code class="computeroutput"><span class="identifier">equal_pointees</span><span class="special">()</span></code></a>
  2044. instead
  2045. </li>
  2046. <li class="listitem">
  2047. <span class="bold"><strong>Example:</strong></span>
  2048. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">oN</span><span class="special">,</span> <span class="identifier">oN_</span><span class="special">;</span>
  2049. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">o1</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">1</span><span class="special">)),</span> <span class="identifier">o1_</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">1</span><span class="special">));</span>
  2050. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">o2</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">2</span><span class="special">));</span>
  2051. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">oN</span> <span class="special">==</span> <span class="identifier">oN</span> <span class="special">);</span> <span class="comment">// Identity implies equality</span>
  2052. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">o1</span> <span class="special">==</span> <span class="identifier">o1</span> <span class="special">);</span> <span class="comment">//</span>
  2053. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">oN</span> <span class="special">==</span> <span class="identifier">oN_</span> <span class="special">);</span> <span class="comment">// Both uninitialized compare equal</span>
  2054. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">oN</span> <span class="special">!=</span> <span class="identifier">o1</span> <span class="special">);</span> <span class="comment">// Initialized unequal to initialized.</span>
  2055. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">o1</span> <span class="special">==</span> <span class="identifier">o1_</span> <span class="special">);</span> <span class="comment">// Both initialized compare as (*lhs == *rhs)</span>
  2056. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">o1</span> <span class="special">!=</span> <span class="identifier">o2</span> <span class="special">);</span> <span class="comment">//</span>
  2057. </pre>
  2058. </li>
  2059. </ul></div>
  2060. <p>
  2061. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2062. </p>
  2063. <a name="reference_operator_compare_less_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2064. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2065. <span class="special">&lt;</span> <span class="special">(</span>
  2066. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2067. </p></blockquote></div>
  2068. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  2069. <li class="listitem">
  2070. <span class="bold"><strong>Requires:</strong></span> Expression <code class="computeroutput"><span class="special">*</span><span class="identifier">x</span> <span class="special">&lt;</span> <span class="special">*</span><span class="identifier">y</span></code> shall be well-formed and its result
  2071. shall be convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
  2072. </li>
  2073. <li class="listitem">
  2074. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">(!</span><span class="identifier">y</span><span class="special">)</span> <span class="special">?</span> <span class="keyword">false</span> <span class="special">:</span> <span class="special">(!</span><span class="identifier">x</span><span class="special">)</span> <span class="special">?</span> <span class="keyword">true</span> <span class="special">:</span> <span class="special">*</span><span class="identifier">x</span> <span class="special">&lt;</span>
  2075. <span class="special">*</span><span class="identifier">y</span></code>.
  2076. </li>
  2077. <li class="listitem">
  2078. <span class="bold"><strong>Notes:</strong></span> This definition guarantees
  2079. that <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code>
  2080. not containing a value is ordered as less than any <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> containing any value, and equivalent
  2081. to any other <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> not containing a value. Pointers
  2082. have shallow relational operators while <code class="computeroutput"><span class="identifier">optional</span></code>
  2083. has deep relational operators. Do not use <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code> directly in generic code which
  2084. expect to be given either an <code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> or a pointer; use <a href="../../../../../../utility/OptionalPointee.html#less" target="_top"><code class="computeroutput"><span class="identifier">less_pointees</span><span class="special">()</span></code></a>
  2085. instead. <code class="computeroutput"><span class="identifier">T</span></code> need not
  2086. be <a href="http://www.sgi.com/tech/stl/LessThanComparable.html" target="_top"><code class="computeroutput"><span class="identifier">LessThanComparable</span></code></a>. Only
  2087. single <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code>
  2088. is required. Other relational operations are defined in terms of this
  2089. one. If <code class="computeroutput"><span class="identifier">T</span></code>'s <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code>
  2090. satisfies the axioms of <a href="http://www.sgi.com/tech/stl/LessThanComparable.html" target="_top"><code class="computeroutput"><span class="identifier">LessThanComparable</span></code></a> (transitivity,
  2091. antisymmetry and irreflexivity), <code class="computeroutput"><span class="identifier">optinal</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code> is <a href="http://www.sgi.com/tech/stl/LessThanComparable.html" target="_top"><code class="computeroutput"><span class="identifier">LessThanComparable</span></code></a>.
  2092. </li>
  2093. <li class="listitem">
  2094. <span class="bold"><strong>Example:</strong></span>
  2095. <pre class="programlisting"><span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">oN</span><span class="special">,</span> <span class="identifier">oN_</span><span class="special">;</span>
  2096. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">o0</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">0</span><span class="special">));</span>
  2097. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">o1</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="number">1</span><span class="special">));</span>
  2098. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">oN</span> <span class="special">&lt;</span> <span class="identifier">oN</span><span class="special">)</span> <span class="special">);</span> <span class="comment">// Identity implies equivalence</span>
  2099. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">o1</span> <span class="special">&lt;</span> <span class="identifier">o1</span><span class="special">)</span> <span class="special">);</span>
  2100. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">oN</span> <span class="special">&lt;</span> <span class="identifier">oN_</span><span class="special">)</span> <span class="special">);</span> <span class="comment">// Two uninitialized are equivalent</span>
  2101. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">oN_</span> <span class="special">&lt;</span> <span class="identifier">oN</span><span class="special">)</span> <span class="special">);</span>
  2102. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">oN</span> <span class="special">&lt;</span> <span class="identifier">o0</span> <span class="special">);</span> <span class="comment">// Uninitialized is less than initialized</span>
  2103. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">o0</span> <span class="special">&lt;</span> <span class="identifier">oN</span><span class="special">)</span> <span class="special">);</span>
  2104. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">o1</span> <span class="special">&lt;</span> <span class="identifier">o2</span> <span class="special">)</span> <span class="special">;</span> <span class="comment">// Two initialized compare as (*lhs &lt; *rhs)</span>
  2105. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">o2</span> <span class="special">&lt;</span> <span class="identifier">o1</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  2106. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!(</span><span class="identifier">o2</span> <span class="special">&lt;</span> <span class="identifier">o2</span><span class="special">)</span> <span class="special">)</span> <span class="special">;</span>
  2107. </pre>
  2108. </li>
  2109. </ul></div>
  2110. <p>
  2111. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2112. </p>
  2113. <a name="reference_operator_compare_not_equal_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2114. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2115. <span class="special">!=</span> <span class="special">(</span>
  2116. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2117. </p></blockquote></div>
  2118. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  2119. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">!(</span>
  2120. <span class="identifier">x</span> <span class="special">==</span>
  2121. <span class="identifier">y</span> <span class="special">);</span></code>
  2122. </li></ul></div>
  2123. <p>
  2124. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2125. </p>
  2126. <a name="reference_operator_compare_greater_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2127. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2128. <span class="special">&gt;</span> <span class="special">(</span>
  2129. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2130. </p></blockquote></div>
  2131. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  2132. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">(</span>
  2133. <span class="identifier">y</span> <span class="special">&lt;</span>
  2134. <span class="identifier">x</span> <span class="special">);</span></code>
  2135. </li></ul></div>
  2136. <p>
  2137. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2138. </p>
  2139. <a name="reference_operator_compare_less_or_equal_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2140. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2141. <span class="special">&lt;=</span> <span class="special">(</span>
  2142. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2143. </p></blockquote></div>
  2144. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  2145. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">!(</span>
  2146. <span class="identifier">y</span> <span class="special">&lt;</span>
  2147. <span class="identifier">x</span> <span class="special">);</span></code>
  2148. </li></ul></div>
  2149. <p>
  2150. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2151. </p>
  2152. <a name="reference_operator_compare_greater_or_equal_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2153. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2154. <span class="special">&gt;=</span> <span class="special">(</span>
  2155. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">y</span> <span class="special">);</span></code>
  2156. </p></blockquote></div>
  2157. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  2158. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">!(</span>
  2159. <span class="identifier">x</span> <span class="special">&lt;</span>
  2160. <span class="identifier">y</span> <span class="special">);</span></code>
  2161. </li></ul></div>
  2162. <p>
  2163. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2164. </p>
  2165. <a name="reference_operator_compare_equal_optional_none"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2166. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2167. <span class="special">==</span> <span class="special">(</span>
  2168. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">none_t</span> <span class="special">)</span>
  2169. <span class="keyword">noexcept</span><span class="special">;</span></code>
  2170. </p></blockquote></div>
  2171. <div class="blockquote"><blockquote class="blockquote"><p>
  2172. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2173. <span class="special">==</span> <span class="special">(</span>
  2174. <span class="identifier">none_t</span><span class="special">,</span>
  2175. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span> <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></code>
  2176. </p></blockquote></div>
  2177. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  2178. <li class="listitem">
  2179. <span class="bold"><strong>Returns:</strong></span> <code class="computeroutput"><span class="special">!</span><span class="identifier">x</span></code>.
  2180. </li>
  2181. <li class="listitem">
  2182. <span class="bold"><strong>Notes:</strong></span> <code class="computeroutput"><span class="identifier">T</span></code>
  2183. need not meet requirements of <a href="http://www.sgi.com/tech/stl/EqualityComparable.html" target="_top"><code class="computeroutput"><span class="identifier">EqualityComparable</span></code></a>.
  2184. </li>
  2185. </ul></div>
  2186. <p>
  2187. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2188. </p>
  2189. <a name="reference_operator_compare_not_equal_optional_none"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2190. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2191. <span class="special">!=</span> <span class="special">(</span>
  2192. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">none_t</span> <span class="special">)</span>
  2193. <span class="keyword">noexcept</span><span class="special">;</span></code>
  2194. </p></blockquote></div>
  2195. <div class="blockquote"><blockquote class="blockquote"><p>
  2196. <code class="computeroutput"><span class="keyword">bool</span> <span class="keyword">operator</span>
  2197. <span class="special">!=</span> <span class="special">(</span>
  2198. <span class="identifier">none_t</span><span class="special">,</span>
  2199. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span> <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></code>
  2200. </p></blockquote></div>
  2201. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  2202. <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">!(</span>
  2203. <span class="identifier">x</span> <span class="special">==</span>
  2204. <span class="identifier">y</span> <span class="special">);</span></code>
  2205. </li></ul></div>
  2206. <p>
  2207. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2208. </p>
  2209. <a name="reference_swap_optional_optional"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2210. <code class="computeroutput"><span class="keyword">void</span> <span class="identifier">swap</span>
  2211. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;&amp;</span> <span class="identifier">y</span>
  2212. <span class="special">)</span> <span class="special">;</span></code>
  2213. </p></blockquote></div>
  2214. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  2215. <li class="listitem">
  2216. <span class="bold"><strong>Requires:</strong></span> Lvalues of type <code class="computeroutput"><span class="identifier">T</span></code> shall be swappable and <code class="computeroutput"><span class="identifier">T</span></code> shall be <code class="computeroutput"><span class="identifier">MoveConstructible</span></code>.
  2217. </li>
  2218. <li class="listitem">
  2219. <p class="simpara">
  2220. <span class="bold"><strong>Effects:</strong></span>
  2221. </p>
  2222. <div class="informaltable"><table class="table">
  2223. <colgroup>
  2224. <col>
  2225. <col>
  2226. <col>
  2227. </colgroup>
  2228. <thead><tr></tr></thead>
  2229. <tbody>
  2230. <tr>
  2231. <td>
  2232. </td>
  2233. <td>
  2234. <p>
  2235. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> contains a value</strong></span>
  2236. </p>
  2237. </td>
  2238. <td>
  2239. <p>
  2240. <span class="bold"><strong><code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value</strong></span>
  2241. </p>
  2242. </td>
  2243. </tr>
  2244. <tr>
  2245. <td>
  2246. <p>
  2247. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  2248. contains a value</strong></span>
  2249. </p>
  2250. </td>
  2251. <td>
  2252. <p>
  2253. calls <code class="computeroutput"><span class="identifier">swap</span><span class="special">(*(*</span><span class="keyword">this</span><span class="special">),</span> <span class="special">*</span><span class="identifier">rhs</span><span class="special">)</span></code>
  2254. </p>
  2255. </td>
  2256. <td>
  2257. <p>
  2258. initializes the contained value of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> as if direct-initializing
  2259. an object of type <code class="computeroutput"><span class="identifier">T</span></code>
  2260. with the expression <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*</span><span class="identifier">rhs</span><span class="special">)</span></code>, followed by <code class="computeroutput"><span class="identifier">rhs</span><span class="special">.</span><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>,
  2261. <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
  2262. contains a value and <code class="computeroutput"><span class="identifier">rhs</span></code>
  2263. does not contain a value
  2264. </p>
  2265. </td>
  2266. </tr>
  2267. <tr>
  2268. <td>
  2269. <p>
  2270. <span class="bold"><strong><code class="computeroutput"><span class="identifier">rhs</span></code>
  2271. does not contain a value</strong></span>
  2272. </p>
  2273. </td>
  2274. <td>
  2275. <p>
  2276. initializes the contained value of <code class="computeroutput"><span class="identifier">rhs</span></code>
  2277. as if direct-initializing an object of type <code class="computeroutput"><span class="identifier">T</span></code> with the expression
  2278. <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">move</span><span class="special">(*(*</span><span class="keyword">this</span><span class="special">))</span></code>,
  2279. followed by <code class="computeroutput"><span class="identifier">val</span><span class="special">-&gt;</span><span class="identifier">T</span><span class="special">::~</span><span class="identifier">T</span><span class="special">()</span></code>, <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> does not contain a value
  2280. and <code class="computeroutput"><span class="identifier">rhs</span></code> contains
  2281. a value
  2282. </p>
  2283. </td>
  2284. <td>
  2285. <p>
  2286. no effect
  2287. </p>
  2288. </td>
  2289. </tr>
  2290. </tbody>
  2291. </table></div>
  2292. </li>
  2293. <li class="listitem">
  2294. <span class="bold"><strong>Postconditions:</strong></span> The states of <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code>
  2295. interchanged.
  2296. </li>
  2297. <li class="listitem">
  2298. <span class="bold"><strong>Throws:</strong></span> If both are initialized, whatever
  2299. <code class="computeroutput"><span class="identifier">swap</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;,</span><span class="identifier">T</span><span class="special">&amp;)</span></code>
  2300. throws. If only one is initialized, whatever <code class="computeroutput"><span class="identifier">T</span><span class="special">::</span><span class="identifier">T</span> <span class="special">(</span> <span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="special">)</span></code>
  2301. throws.
  2302. </li>
  2303. <li class="listitem">
  2304. <span class="bold"><strong>Example:</strong></span>
  2305. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">x</span><span class="special">(</span><span class="number">12</span><span class="special">);</span>
  2306. <span class="identifier">T</span> <span class="identifier">y</span><span class="special">(</span><span class="number">21</span><span class="special">);</span>
  2307. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def0</span> <span class="special">;</span>
  2308. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">def1</span> <span class="special">;</span>
  2309. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">optX</span><span class="special">(</span><span class="identifier">x</span><span class="special">);</span>
  2310. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">optY</span><span class="special">(</span><span class="identifier">y</span><span class="special">);</span>
  2311. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">def0</span><span class="special">,</span><span class="identifier">def1</span><span class="special">);</span> <span class="comment">// no-op</span>
  2312. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">def0</span><span class="special">,</span><span class="identifier">optX</span><span class="special">);</span>
  2313. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">def0</span> <span class="special">==</span> <span class="identifier">x</span> <span class="special">);</span>
  2314. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">optX</span> <span class="special">);</span>
  2315. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">def0</span><span class="special">,</span><span class="identifier">optX</span><span class="special">);</span> <span class="comment">// Get back to original values</span>
  2316. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">optX</span><span class="special">,</span><span class="identifier">optY</span><span class="special">);</span>
  2317. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">optX</span> <span class="special">==</span> <span class="identifier">y</span> <span class="special">);</span>
  2318. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">*</span><span class="identifier">optY</span> <span class="special">==</span> <span class="identifier">x</span> <span class="special">);</span>
  2319. </pre>
  2320. </li>
  2321. </ul></div>
  2322. <p>
  2323. <span class="inlinemediaobject"><img src="../../../images/space.png" alt="space"></span>
  2324. </p>
  2325. <a name="reference_swap_optional_reference"></a><div class="blockquote"><blockquote class="blockquote"><p>
  2326. <code class="computeroutput"><span class="keyword">void</span> <span class="identifier">swap</span>
  2327. <span class="special">(</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;&amp;</span> <span class="identifier">y</span>
  2328. <span class="special">)</span> <span class="keyword">noexcept</span>
  2329. <span class="special">;</span></code>
  2330. </p></blockquote></div>
  2331. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  2332. <li class="listitem">
  2333. <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="identifier">x</span></code>
  2334. refers to what <code class="computeroutput"><span class="identifier">y</span></code> refererred
  2335. to before the swap (if anything). <code class="computeroutput"><span class="identifier">y</span></code>
  2336. refers to whatever <code class="computeroutput"><span class="identifier">x</span></code>
  2337. referred to before the swap.
  2338. </li>
  2339. <li class="listitem">
  2340. <span class="bold"><strong>Example:</strong></span>
  2341. <pre class="programlisting"><span class="identifier">T</span> <span class="identifier">x</span><span class="special">(</span><span class="number">12</span><span class="special">);</span>
  2342. <span class="identifier">T</span> <span class="identifier">y</span><span class="special">(</span><span class="number">21</span><span class="special">);</span>
  2343. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">opt0</span><span class="special">;</span>
  2344. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">optX</span> <span class="special">(</span><span class="identifier">x</span><span class="special">);</span>
  2345. <span class="identifier">optional</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&amp;&gt;</span> <span class="identifier">optY</span> <span class="special">(</span><span class="identifier">y</span><span class="special">);</span>
  2346. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">optX</span><span class="special">,</span> <span class="identifier">optY</span><span class="special">);</span>
  2347. <span class="identifier">assert</span> <span class="special">(</span><span class="identifier">addressof</span><span class="special">(*</span><span class="identifier">optX</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">addressof</span><span class="special">(</span><span class="identifier">y</span><span class="special">));</span>
  2348. <span class="identifier">assert</span> <span class="special">(</span><span class="identifier">addressof</span><span class="special">(*</span><span class="identifier">optY</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">addressof</span><span class="special">(</span><span class="identifier">x</span><span class="special">));</span>
  2349. <span class="identifier">boost</span><span class="special">::</span><span class="identifier">swap</span><span class="special">(</span><span class="identifier">opt0</span><span class="special">,</span> <span class="identifier">optX</span><span class="special">);</span>
  2350. <span class="identifier">assert</span> <span class="special">(</span> <span class="identifier">opt0</span> <span class="special">);</span>
  2351. <span class="identifier">assert</span> <span class="special">(</span> <span class="special">!</span><span class="identifier">optX</span> <span class="special">);</span>
  2352. <span class="identifier">assert</span> <span class="special">(</span><span class="identifier">addressof</span><span class="special">(*</span><span class="identifier">opt0</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">addressof</span><span class="special">(</span><span class="identifier">y</span><span class="special">));</span>
  2353. </pre>
  2354. [endsect]
  2355. </li>
  2356. </ul></div>
  2357. </div>
  2358. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  2359. <td align="left"></td>
  2360. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2007 Fernando Luis Cacciola Carballal<br>Copyright &#169; 2014-2016 Andrzej Krzemie&#324;ski<p>
  2361. Distributed under the Boost Software License, Version 1.0. (See accompanying
  2362. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  2363. </p>
  2364. </div></td>
  2365. </tr></table>
  2366. <hr>
  2367. <div class="spirit-nav">
  2368. <a accesskey="p" href="header_optional_optional_refs.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../optional/reference/header__boost_optional_optional_hpp_.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="header__boost_optional_hpp_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  2369. </div>
  2370. </body>
  2371. </html>