3252 lines
175 KiB
HTML
3252 lines
175 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="Asciidoctor 2.0.23">
|
|
<meta name="author" content="C++11 Implementations of Standard Components Added in Later C++ Standards">
|
|
<title>Boost.Compat</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
|
|
<style>
|
|
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
|
/* Uncomment the following line when using as a custom stylesheet */
|
|
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
|
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
|
a{background:none}
|
|
a:focus{outline:thin dotted}
|
|
a:active,a:hover{outline:0}
|
|
h1{font-size:2em;margin:.67em 0}
|
|
b,strong{font-weight:bold}
|
|
abbr{font-size:.9em}
|
|
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
|
dfn{font-style:italic}
|
|
hr{height:0}
|
|
mark{background:#ff0;color:#000}
|
|
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
|
pre{white-space:pre-wrap}
|
|
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
|
small{font-size:80%}
|
|
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
|
sup{top:-.5em}
|
|
sub{bottom:-.25em}
|
|
img{border:0}
|
|
svg:not(:root){overflow:hidden}
|
|
figure{margin:0}
|
|
audio,video{display:inline-block}
|
|
audio:not([controls]){display:none;height:0}
|
|
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
|
legend{border:0;padding:0}
|
|
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
|
button,input{line-height:normal}
|
|
button,select{text-transform:none}
|
|
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
|
button[disabled],html input[disabled]{cursor:default}
|
|
input[type=checkbox],input[type=radio]{padding:0}
|
|
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
|
textarea{overflow:auto;vertical-align:top}
|
|
table{border-collapse:collapse;border-spacing:0}
|
|
*,::before,::after{box-sizing:border-box}
|
|
html,body{font-size:100%}
|
|
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
|
a:hover{cursor:pointer}
|
|
img,object,embed{max-width:100%;height:auto}
|
|
object,embed{height:100%}
|
|
img{-ms-interpolation-mode:bicubic}
|
|
.left{float:left!important}
|
|
.right{float:right!important}
|
|
.text-left{text-align:left!important}
|
|
.text-right{text-align:right!important}
|
|
.text-center{text-align:center!important}
|
|
.text-justify{text-align:justify!important}
|
|
.hide{display:none}
|
|
img,object,svg{display:inline-block;vertical-align:middle}
|
|
textarea{height:auto;min-height:50px}
|
|
select{width:100%}
|
|
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
|
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
|
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
|
a:hover,a:focus{color:#1d4b8f}
|
|
a img{border:0}
|
|
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
|
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
|
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
|
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
|
h1{font-size:2.125em}
|
|
h2{font-size:1.6875em}
|
|
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
|
h4,h5{font-size:1.125em}
|
|
h6{font-size:1em}
|
|
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
|
em,i{font-style:italic;line-height:inherit}
|
|
strong,b{font-weight:bold;line-height:inherit}
|
|
small{font-size:60%;line-height:inherit}
|
|
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
|
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
|
ul,ol{margin-left:1.5em}
|
|
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
|
ul.circle{list-style-type:circle}
|
|
ul.disc{list-style-type:disc}
|
|
ul.square{list-style-type:square}
|
|
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
|
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
|
dl dt{margin-bottom:.3125em;font-weight:bold}
|
|
dl dd{margin-bottom:1.25em}
|
|
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
|
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
|
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
|
h1{font-size:2.75em}
|
|
h2{font-size:2.3125em}
|
|
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
|
h4{font-size:1.4375em}}
|
|
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
|
table thead,table tfoot{background:#f7f8f7}
|
|
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
|
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
|
table tr.even,table tr.alt{background:#f8f8f7}
|
|
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
|
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
|
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
|
.center{margin-left:auto;margin-right:auto}
|
|
.stretch{width:100%}
|
|
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
|
.clearfix::after,.float-group::after{clear:both}
|
|
:not(pre).nobreak{word-wrap:normal}
|
|
:not(pre).nowrap{white-space:nowrap}
|
|
:not(pre).pre-wrap{white-space:pre-wrap}
|
|
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
|
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
|
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
|
pre>code{display:block}
|
|
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
|
em em{font-style:normal}
|
|
strong strong{font-weight:400}
|
|
.keyseq{color:rgba(51,51,51,.8)}
|
|
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
|
.keyseq kbd:first-child{margin-left:0}
|
|
.keyseq kbd:last-child{margin-right:0}
|
|
.menuseq,.menuref{color:#000}
|
|
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
|
.menuseq{word-spacing:-.02em}
|
|
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
|
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
|
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
|
b.button::before{content:"[";padding:0 3px 0 2px}
|
|
b.button::after{content:"]";padding:0 2px 0 3px}
|
|
p a>code:hover{color:rgba(0,0,0,.9)}
|
|
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
|
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
|
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
|
#content{margin-top:1.25em}
|
|
#content::before{content:none}
|
|
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
|
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
|
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
|
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
|
#header .details span:first-child{margin-left:-.125em}
|
|
#header .details span.email a{color:rgba(0,0,0,.85)}
|
|
#header .details br{display:none}
|
|
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
|
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
|
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
|
#header #revnumber{text-transform:capitalize}
|
|
#header #revnumber::after{content:"\00a0"}
|
|
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
|
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
|
#toc>ul{margin-left:.125em}
|
|
#toc ul.sectlevel0>li>a{font-style:italic}
|
|
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
|
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
|
#toc li{line-height:1.3334;margin-top:.3334em}
|
|
#toc a{text-decoration:none}
|
|
#toc a:active{text-decoration:underline}
|
|
#toctitle{color:#7a2518;font-size:1.2em}
|
|
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
|
body.toc2{padding-left:15em;padding-right:0}
|
|
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
|
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
|
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
|
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
|
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
|
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
|
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
|
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
|
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
|
#toc.toc2{width:20em}
|
|
#toc.toc2 #toctitle{font-size:1.375em}
|
|
#toc.toc2>ul{font-size:.95em}
|
|
#toc.toc2 ul ul{padding-left:1.25em}
|
|
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
|
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
|
#content #toc>:first-child{margin-top:0}
|
|
#content #toc>:last-child{margin-bottom:0}
|
|
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
|
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
|
#content{margin-bottom:.625em}
|
|
.sect1{padding-bottom:.625em}
|
|
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
|
.sect1{padding-bottom:1.25em}}
|
|
.sect1:last-child{padding-bottom:0}
|
|
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
|
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
|
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
|
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
|
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
|
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
|
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
|
details{margin-left:1.25rem}
|
|
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
|
details>summary::-webkit-details-marker{display:none}
|
|
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
|
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
|
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
|
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
|
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
|
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
|
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
|
.admonitionblock>table td.icon{text-align:center;width:80px}
|
|
.admonitionblock>table td.icon img{max-width:none}
|
|
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
|
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
|
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
|
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
|
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
|
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
|
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
|
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
|
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
|
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
|
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
|
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
|
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
|
.listingblock>.content{position:relative}
|
|
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
|
.listingblock:hover code[data-lang]::before{display:block}
|
|
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
|
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
|
.listingblock pre.highlightjs{padding:0}
|
|
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
|
.listingblock pre.prettyprint{border-width:0}
|
|
.prettyprint{background:#f7f7f8}
|
|
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
|
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
|
pre.prettyprint li code[data-lang]::before{opacity:1}
|
|
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
|
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
|
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
|
table.linenotable td.code{padding-left:.75em}
|
|
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
|
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
|
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
|
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
|
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
|
.quoteblock blockquote{margin:0;padding:0;border:0}
|
|
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
|
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
|
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
|
.verseblock{margin:0 1em 1.25em}
|
|
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
|
.verseblock pre strong{font-weight:400}
|
|
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
|
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
|
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
|
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
|
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
|
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
|
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
|
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
|
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
|
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
|
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
|
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
|
p.tableblock:last-child{margin-bottom:0}
|
|
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
|
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
|
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
|
table.grid-all>*>tr>*{border-width:1px}
|
|
table.grid-cols>*>tr>*{border-width:0 1px}
|
|
table.grid-rows>*>tr>*{border-width:1px 0}
|
|
table.frame-all{border-width:1px}
|
|
table.frame-ends{border-width:1px 0}
|
|
table.frame-sides{border-width:0 1px}
|
|
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
|
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
|
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
|
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
|
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
|
th.halign-left,td.halign-left{text-align:left}
|
|
th.halign-right,td.halign-right{text-align:right}
|
|
th.halign-center,td.halign-center{text-align:center}
|
|
th.valign-top,td.valign-top{vertical-align:top}
|
|
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
|
th.valign-middle,td.valign-middle{vertical-align:middle}
|
|
table thead th,table tfoot th{font-weight:bold}
|
|
tbody tr th{background:#f7f8f7}
|
|
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
|
p.tableblock>code:only-child{background:none;padding:0}
|
|
p.tableblock{font-size:1em}
|
|
ol{margin-left:1.75em}
|
|
ul li ol{margin-left:1.5em}
|
|
dl dd{margin-left:1.125em}
|
|
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
|
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
|
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
|
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
|
ul.unstyled,ol.unstyled{margin-left:0}
|
|
li>p:empty:only-child::before{content:"";display:inline-block}
|
|
ul.checklist>li>p:first-child{margin-left:-1em}
|
|
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
|
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
|
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
|
ul.inline>li{margin-left:1.25em}
|
|
.unstyled dl dt{font-weight:400;font-style:normal}
|
|
ol.arabic{list-style-type:decimal}
|
|
ol.decimal{list-style-type:decimal-leading-zero}
|
|
ol.loweralpha{list-style-type:lower-alpha}
|
|
ol.upperalpha{list-style-type:upper-alpha}
|
|
ol.lowerroman{list-style-type:lower-roman}
|
|
ol.upperroman{list-style-type:upper-roman}
|
|
ol.lowergreek{list-style-type:lower-greek}
|
|
.hdlist>table,.colist>table{border:0;background:none}
|
|
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
|
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
|
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
|
td.hdlist2{word-wrap:anywhere}
|
|
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
|
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
|
.colist td:not([class]):first-child img{max-width:none}
|
|
.colist td:not([class]):last-child{padding:.25em 0}
|
|
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
|
.imageblock.left{margin:.25em .625em 1.25em 0}
|
|
.imageblock.right{margin:.25em 0 1.25em .625em}
|
|
.imageblock>.title{margin-bottom:0}
|
|
.imageblock.thumb,.imageblock.th{border-width:6px}
|
|
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
|
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
|
.image.left{margin-right:.625em}
|
|
.image.right{margin-left:.625em}
|
|
a.image{text-decoration:none;display:inline-block}
|
|
a.image object{pointer-events:none}
|
|
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
|
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
|
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
|
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
|
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
|
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
|
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
|
#footnotes .footnote:last-of-type{margin-bottom:0}
|
|
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
|
div.unbreakable{page-break-inside:avoid}
|
|
.big{font-size:larger}
|
|
.small{font-size:smaller}
|
|
.underline{text-decoration:underline}
|
|
.overline{text-decoration:overline}
|
|
.line-through{text-decoration:line-through}
|
|
.aqua{color:#00bfbf}
|
|
.aqua-background{background:#00fafa}
|
|
.black{color:#000}
|
|
.black-background{background:#000}
|
|
.blue{color:#0000bf}
|
|
.blue-background{background:#0000fa}
|
|
.fuchsia{color:#bf00bf}
|
|
.fuchsia-background{background:#fa00fa}
|
|
.gray{color:#606060}
|
|
.gray-background{background:#7d7d7d}
|
|
.green{color:#006000}
|
|
.green-background{background:#007d00}
|
|
.lime{color:#00bf00}
|
|
.lime-background{background:#00fa00}
|
|
.maroon{color:#600000}
|
|
.maroon-background{background:#7d0000}
|
|
.navy{color:#000060}
|
|
.navy-background{background:#00007d}
|
|
.olive{color:#606000}
|
|
.olive-background{background:#7d7d00}
|
|
.purple{color:#600060}
|
|
.purple-background{background:#7d007d}
|
|
.red{color:#bf0000}
|
|
.red-background{background:#fa0000}
|
|
.silver{color:#909090}
|
|
.silver-background{background:#bcbcbc}
|
|
.teal{color:#006060}
|
|
.teal-background{background:#007d7d}
|
|
.white{color:#bfbfbf}
|
|
.white-background{background:#fafafa}
|
|
.yellow{color:#bfbf00}
|
|
.yellow-background{background:#fafa00}
|
|
span.icon>.fa{cursor:default}
|
|
a span.icon>.fa{cursor:inherit}
|
|
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
|
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
|
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
|
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
|
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
|
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
|
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
|
.conum[data-value] *{color:#fff!important}
|
|
.conum[data-value]+b{display:none}
|
|
.conum[data-value]::after{content:attr(data-value)}
|
|
pre .conum[data-value]{position:relative;top:-.125em}
|
|
b.conum *{color:inherit!important}
|
|
.conum:not([data-value]):empty{display:none}
|
|
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
|
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
|
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
|
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
|
p{margin-bottom:1.25rem}
|
|
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
|
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
|
.print-only{display:none!important}
|
|
@page{margin:1.25cm .75cm}
|
|
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
|
html{font-size:80%}
|
|
a{color:inherit!important;text-decoration:underline!important}
|
|
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
|
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
|
abbr[title]{border-bottom:1px dotted}
|
|
abbr[title]::after{content:" (" attr(title) ")"}
|
|
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
|
thead{display:table-header-group}
|
|
svg{max-width:100%}
|
|
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
|
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
|
#header,#content,#footnotes,#footer{max-width:none}
|
|
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
|
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
|
body.book #header{text-align:center}
|
|
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
|
body.book #header .details{border:0!important;display:block;padding:0!important}
|
|
body.book #header .details span:first-child{margin-left:0!important}
|
|
body.book #header .details br{display:block}
|
|
body.book #header .details br+span::before{content:none!important}
|
|
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
|
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
|
.listingblock code[data-lang]::before{display:block}
|
|
#footer{padding:0 .9375em}
|
|
.hide-on-print{display:none!important}
|
|
.print-only{display:block!important}
|
|
.hide-for-print{display:none!important}
|
|
.show-for-print{display:inherit!important}}
|
|
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
|
.sect1{padding:0!important}
|
|
.sect1+.sect1{border:0}
|
|
#footer{background:none}
|
|
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
|
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
|
</style>
|
|
<style>
|
|
pre.rouge table td { padding: 5px; }
|
|
pre.rouge table pre { margin: 0; }
|
|
pre.rouge, pre.rouge .w {
|
|
color: #24292f;
|
|
background-color: #f6f8fa;
|
|
}
|
|
pre.rouge .k, pre.rouge .kd, pre.rouge .kn, pre.rouge .kp, pre.rouge .kr, pre.rouge .kt, pre.rouge .kv {
|
|
color: #cf222e;
|
|
}
|
|
pre.rouge .gr {
|
|
color: #f6f8fa;
|
|
}
|
|
pre.rouge .gd {
|
|
color: #82071e;
|
|
background-color: #ffebe9;
|
|
}
|
|
pre.rouge .nb {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .nc {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .no {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .nn {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .sr {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .na {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .nt {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .gi {
|
|
color: #116329;
|
|
background-color: #dafbe1;
|
|
}
|
|
pre.rouge .ges {
|
|
font-weight: bold;
|
|
font-style: italic;
|
|
}
|
|
pre.rouge .kc {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .l, pre.rouge .ld, pre.rouge .m, pre.rouge .mb, pre.rouge .mf, pre.rouge .mh, pre.rouge .mi, pre.rouge .il, pre.rouge .mo, pre.rouge .mx {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .sb {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .bp {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .ne {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .nl {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .py {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .nv, pre.rouge .vc, pre.rouge .vg, pre.rouge .vi, pre.rouge .vm {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .o, pre.rouge .ow {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .gh {
|
|
color: #0550ae;
|
|
font-weight: bold;
|
|
}
|
|
pre.rouge .gu {
|
|
color: #0550ae;
|
|
font-weight: bold;
|
|
}
|
|
pre.rouge .s, pre.rouge .sa, pre.rouge .sc, pre.rouge .dl, pre.rouge .sd, pre.rouge .s2, pre.rouge .se, pre.rouge .sh, pre.rouge .sx, pre.rouge .s1, pre.rouge .ss {
|
|
color: #0a3069;
|
|
}
|
|
pre.rouge .nd {
|
|
color: #8250df;
|
|
}
|
|
pre.rouge .nf, pre.rouge .fm {
|
|
color: #8250df;
|
|
}
|
|
pre.rouge .err {
|
|
color: #f6f8fa;
|
|
background-color: #82071e;
|
|
}
|
|
pre.rouge .c, pre.rouge .ch, pre.rouge .cd, pre.rouge .cm, pre.rouge .cp, pre.rouge .cpf, pre.rouge .c1, pre.rouge .cs {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .gl {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .gt {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .ni {
|
|
color: #24292f;
|
|
}
|
|
pre.rouge .si {
|
|
color: #24292f;
|
|
}
|
|
pre.rouge .ge {
|
|
color: #24292f;
|
|
font-style: italic;
|
|
}
|
|
pre.rouge .gs {
|
|
color: #24292f;
|
|
font-weight: bold;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="article toc2 toc-left">
|
|
<div id="header">
|
|
<h1>Boost.Compat</h1>
|
|
<div class="details">
|
|
<span id="author" class="author">C++11 Implementations of Standard Components Added in Later C++ Standards</span><br>
|
|
</div>
|
|
<div id="toc" class="toc2">
|
|
<div id="toctitle">Table of Contents</div>
|
|
<ul class="sectlevel1">
|
|
<li><a href="#overview">Overview</a></li>
|
|
<li><a href="#changelog">Revision History</a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#changelog_changes_in_1_90_0">Changes in 1.90.0</a></li>
|
|
<li><a href="#changelog_changes_in_1_89_0">Changes in 1.89.0</a></li>
|
|
<li><a href="#changelog_changes_in_1_87_0">Changes in 1.87.0</a></li>
|
|
<li><a href="#changelog_changes_in_1_86_0">Changes in 1.86.0</a></li>
|
|
<li><a href="#changelog_changes_in_1_83_0">Changes in 1.83.0</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#bind_back"><boost/compat/bind_back.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_bind_back_description">Description</a></li>
|
|
<li><a href="#ref_bind_back_example">Example</a></li>
|
|
<li><a href="#ref_bind_back_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_bind_back_bind_back">bind_back</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#bind_front"><boost/compat/bind_front.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_bind_front_description">Description</a></li>
|
|
<li><a href="#ref_bind_front_example">Example</a></li>
|
|
<li><a href="#ref_bind_front_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_bind_front_bind_front">bind_front</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#function_ref"><boost/compat/function_ref.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_function_ref_description">Description</a></li>
|
|
<li><a href="#ref_function_ref_example">Example</a></li>
|
|
<li><a href="#ref_function_ref_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_function_ref_constructors">Constructors</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_function_ref_function_pointer_constructor">Function Pointer Constructor</a></li>
|
|
<li><a href="#ref_function_ref_object_constructor">Object Constructor</a></li>
|
|
<li><a href="#ref_function_ref_pointer_to_member_function_constructor">Pointer to Member Function Constructor</a></li>
|
|
<li><a href="#ref_function_ref_bound_object_constructor">Bound Object Constructor</a></li>
|
|
<li><a href="#ref_function_ref_bound_pointer_constructor">Bound Pointer Constructor</a></li>
|
|
<li><a href="#ref_function_ref_copy_constructor">Copy Constructor</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_function_ref_member_functions">Member Functions</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_function_ref_call_operator">call operator</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_function_ref_assignment">Assignment</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_function_ref_copy_assignment">Copy Assignment</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#integer_sequence"><boost/compat/integer_sequence.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_integer_sequence_description">Description</a></li>
|
|
<li><a href="#ref_integer_sequence_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_integer_sequence_integer_sequence">integer_sequence</a></li>
|
|
<li><a href="#ref_integer_sequence_make_integer_sequence">make_integer_sequence</a></li>
|
|
<li><a href="#ref_integer_sequence_index_sequence">index_sequence</a></li>
|
|
<li><a href="#ref_integer_sequence_make_index_sequence">make_index_sequence</a></li>
|
|
<li><a href="#ref_integer_sequence_index_sequence_for">index_sequence_for</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#invoke"><boost/compat/invoke.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_invoke_description">Description</a></li>
|
|
<li><a href="#ref_invoke_example">Example</a></li>
|
|
<li><a href="#ref_invoke_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_invoke_invoke">invoke</a></li>
|
|
<li><a href="#ref_invoke_invoke_result_t">invoke_result_t</a></li>
|
|
<li><a href="#ref_invoke_is_invocable">is_invocable</a></li>
|
|
<li><a href="#ref_invoke_is_nothrow_invocable">is_nothrow_invocable</a></li>
|
|
<li><a href="#ref_invoke_invoke_r">invoke_r</a></li>
|
|
<li><a href="#ref_invoke_is_invocable_r">is_invocable_r</a></li>
|
|
<li><a href="#ref_invoke_is_nothrow_invocable_r">is_nothrow_invocable_r</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#latch"><boost/compat/latch.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_latch_description">Description</a></li>
|
|
<li><a href="#ref_latch_example">Example</a></li>
|
|
<li><a href="#ref_latch_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_latch_constructors">Constructors</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_latch_counter_constructor">Counter Constructor</a></li>
|
|
<li><a href="#ref_latch_copy_constructor">Copy Constructor</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_latch_member_functions">Member Functions</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_latch_count_down">count_down</a></li>
|
|
<li><a href="#ref_latch_try_wait">try_wait</a></li>
|
|
<li><a href="#ref_latch_wait">wait</a></li>
|
|
<li><a href="#ref_latch_arrive_and_wait">arrive_and_wait</a></li>
|
|
<li><a href="#ref_latch_max">max</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#mem_fn"><boost/compat/mem_fn.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_mem_fn_description">Description</a></li>
|
|
<li><a href="#ref_mem_fn_example">Example</a></li>
|
|
<li><a href="#ref_mem_fn_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_mem_fn_mem_fn">mem_fn</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#move_only_function"><boost/compat/move_only_function.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_move_only_function_description">Description</a></li>
|
|
<li><a href="#ref_move_only_function_example">Example</a></li>
|
|
<li><a href="#ref_move_only_function_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_move_only_function_constructors">Constructors</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_move_only_function_default_constructor">Default Constructor</a></li>
|
|
<li><a href="#ref_move_only_function_null_constructor">Null Constructor</a></li>
|
|
<li><a href="#ref_move_only_function_object_constructor">Object Constructor</a></li>
|
|
<li><a href="#ref_move_only_function_in_place_constructor">In-Place Constructor</a></li>
|
|
<li><a href="#ref_move_only_function_list_in_place_constructor">List In-Place Constructor</a></li>
|
|
<li><a href="#ref_move_only_function_move_constructor">Move Constructor</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_move_only_function_assignment">Assignment</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_move_only_function_move_assignment">Move Assignment</a></li>
|
|
<li><a href="#ref_move_only_function_null_assigment">Null Assigment</a></li>
|
|
<li><a href="#ref_move_only_function_callable_assignment">Callable Assignment</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_move_only_function_utility">Utility</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_move_only_function_null_equality">Null Equality</a></li>
|
|
<li><a href="#ref_move_only_function_swap">Swap</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_move_only_function_invocation">Invocation</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_move_only_function_boolean_conversion">Boolean Conversion</a></li>
|
|
<li><a href="#ref_move_only_function_call_operator">Call Operator</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#shared_lock"><boost/compat/shared_lock.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_shared_lock_description">Description</a></li>
|
|
<li><a href="#ref_shared_lock_example">Example</a></li>
|
|
<li><a href="#ref_shared_lock_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_shared_lock_constructors">Constructors</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_shared_lock_default_constructor">Default Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_locking_constructor">Locking Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_deferred_constructor">Deferred Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_try_to_lock_constructor">Try-to-Lock Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_adopting_constructor">Adopting Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_copy_constructor">Copy Constructor</a></li>
|
|
<li><a href="#ref_shared_lock_move_constructor">Move Constructor</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_shared_lock_assignment">Assignment</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_shared_lock_copy_assignment">Copy Assignment</a></li>
|
|
<li><a href="#ref_shared_lock_move_assignment">Move Assignment</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_shared_lock_destructor">Destructor</a></li>
|
|
<li><a href="#ref_shared_lock_member_functions">Member Functions</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#ref_shared_lock_locking">Locking</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#ref_shared_lock_lock">lock</a></li>
|
|
<li><a href="#ref_shared_lock_try_lock">try_lock</a></li>
|
|
<li><a href="#ref_shared_lock_unlock">unlock</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_shared_lock_modifiers">Modifiers</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#ref_shared_lock_swap">swap</a></li>
|
|
<li><a href="#ref_shared_lock_release">release</a></li>
|
|
<li><a href="#ref_shared_lock_free_function_swap">Free Function swap</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#ref_shared_lock_observers">Observers</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#ref_shared_lock_mutex">mutex</a></li>
|
|
<li><a href="#ref_shared_lock_owns_lock">owns_lock</a></li>
|
|
<li><a href="#ref_shared_lock_boolean_conversion">boolean conversion</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#to_array"><boost/compat/to_array.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_to_array_description">Description</a></li>
|
|
<li><a href="#ref_to_array_example">Example</a></li>
|
|
<li><a href="#ref_to_array_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_to_array_to_array">to_array</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#to_underlying"><boost/compat/to_underlying.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_to_underlying_description">Description</a></li>
|
|
<li><a href="#ref_to_underlying_example">Example</a></li>
|
|
<li><a href="#ref_to_underlying_synopsis">Synopsis</a></li>
|
|
<li><a href="#ref_to_underlying_to_underlying">to_underlying</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#type_traits"><boost/compat/type_traits.hpp></a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#ref_type_traits_description">Description</a></li>
|
|
<li><a href="#ref_type_traits_synopsis">Synopsis</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#copyright">Copyright and License</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="overview">Overview</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>Boost.Compat is a repository of C++11 implementations
|
|
of standard components added in later C++ standards. Its
|
|
target audience is Boost library authors whose libraries
|
|
support a lower C++ standard, but wish to utilize a component
|
|
added in a subsequent one.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The criteria for inclusion in Boost.Compat are as follows:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>The implementation should be relatively simple and
|
|
header-only.</p>
|
|
</li>
|
|
<li>
|
|
<p>The component must implement the standard functionality
|
|
exactly, without deviations or extensions. This allows
|
|
(but does not require) the implementation to be a simple
|
|
<code>using</code> declaration in case the standard component is
|
|
available.</p>
|
|
</li>
|
|
<li>
|
|
<p>The component must not depend on any Boost libraries
|
|
except Boost.Config, Boost.Assert, or Boost.ThrowException.</p>
|
|
</li>
|
|
<li>
|
|
<p>The component must not be a vocabulary type, visible in
|
|
the library APIs. The user should never see a <code>boost::compat</code>
|
|
type; the use of Compat types should be confined to library
|
|
implementations.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="changelog">Revision History</h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="changelog_changes_in_1_90_0">Changes in 1.90.0</h3>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Added <code>to_underlying.hpp</code> (contributed by Braden Ganetsky.)</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="changelog_changes_in_1_89_0">Changes in 1.89.0</h3>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Added <code>move_only_function.hpp</code>.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="changelog_changes_in_1_87_0">Changes in 1.87.0</h3>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Added <code>to_array.hpp</code> (contributed by Ruben Perez Hidalgo.)</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="changelog_changes_in_1_86_0">Changes in 1.86.0</h3>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Added <code>bind_front.hpp</code>, <code>bind_back.hpp</code>, <code>invoke.hpp</code>, <code>mem_fn.hpp</code>, <code>integer_sequence.hpp</code> and <code>type_traits.hpp</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p>Added <code>function_ref.hpp</code>.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="changelog_changes_in_1_83_0">Changes in 1.83.0</h3>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Added <code>latch.hpp</code>, an implementation of <code>std::latch</code> (contributed by Christian Mazakas.)</p>
|
|
</li>
|
|
<li>
|
|
<p>Added <code>shared_lock.hpp</code>, a (partial) implementation of <code>std::shared_lock</code> (contributed by Christian Mazakas.)</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="bind_back"><boost/compat/bind_back.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_back_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/bind_back.hpp></code> implements the C++20 function
|
|
<code>std::bind_back</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>bind_back</code> is a limited variant of <code>std::bind</code>. It only supports binding
|
|
the last several parameters of a function object to specific argument values.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_back_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">struct</span> <span class="nc">X</span>
|
|
<span class="p">{</span>
|
|
<span class="kt">void</span> <span class="n">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">a</span><span class="p">,</span> <span class="kt">int</span> <span class="n">b</span><span class="p">)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="kt">int</span> <span class="nf">main</span><span class="p">()</span>
|
|
<span class="p">{</span>
|
|
<span class="k">auto</span> <span class="n">fn</span> <span class="o">=</span> <span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">bind_back</span><span class="p">(</span><span class="o">&</span><span class="n">X</span><span class="o">::</span><span class="n">f</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span>
|
|
|
|
<span class="n">X</span> <span class="n">x</span><span class="p">;</span>
|
|
<span class="n">fn</span><span class="p">(</span><span class="n">x</span><span class="p">);</span> <span class="c1">// calls x.f(1, 2)</span>
|
|
<span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_back_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="n">bind_back</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">);</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_back_bind_back">bind_back</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="nf">bind_back</span><span class="p">(</span> <span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>A function object <code>fn</code> such that <code>fn(b…​)</code> is equivalent to
|
|
<code>invoke(f, b…​, a…​)</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="bind_front"><boost/compat/bind_front.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_front_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/bind_front.hpp></code> implements the C++20 function
|
|
<code>std::bind_front</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>bind_front</code> is a limited variant of <code>std::bind</code>. It only supports binding
|
|
the first several parameters of a function object to specific argument values.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_front_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">struct</span> <span class="nc">X</span>
|
|
<span class="p">{</span>
|
|
<span class="kt">void</span> <span class="n">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">a</span><span class="p">,</span> <span class="kt">int</span> <span class="n">b</span><span class="p">)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="kt">int</span> <span class="nf">main</span><span class="p">()</span>
|
|
<span class="p">{</span>
|
|
<span class="n">X</span> <span class="n">x</span><span class="p">;</span>
|
|
<span class="k">auto</span> <span class="n">fn</span> <span class="o">=</span> <span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">bind_front</span><span class="p">(</span><span class="o">&</span><span class="n">X</span><span class="o">::</span><span class="n">f</span><span class="p">,</span> <span class="o">&</span><span class="n">x</span><span class="p">);</span>
|
|
|
|
<span class="n">fn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> <span class="c1">// calls x.f(1, 2)</span>
|
|
<span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_front_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="n">bind_front</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">);</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_bind_front_bind_front">bind_front</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="nf">bind_front</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>A function object <code>fn</code> such that <code>fn(b…​)</code> is equivalent to
|
|
<code>invoke(f, a…​, b…​)</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="function_ref"><boost/compat/function_ref.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/function_ref.hpp></code> implements the C++26 class
|
|
<code>std::function_ref</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>function_ref</code> is a lightweight polymorphic function wrapper that only stores a pointer to the supplied <a href="https://en.cppreference.com/w/cpp/named_req/Callable">Callable</a> object and a pointer to an unspecified function, meaning it does not participate in ownership of the Callable and does not allocate. All specializations of <code>function_ref</code> satisfy <a href="https://en.cppreference.com/w/cpp/named_req/TriviallyCopyable">TriviallyCopyable</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>function_ref</code> supports every combination of <code>const</code> and <code>noexcept</code> and is useful for writing higher-order functions as
|
|
it can avoid a template parameter or an allocation (as <code>std::function</code> is known for).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Since <code>nontype_t</code> requires C++17 as it has a template parameter of type <code>auto</code>, the constructors taking <code>nontype_t<f></code> are only available under C++17 or later.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">int</span> <span class="n">add</span><span class="p">(</span><span class="kt">int</span> <span class="n">x</span><span class="p">,</span> <span class="kt">int</span> <span class="n">y</span><span class="p">)</span> <span class="k">noexcept</span> <span class="p">{</span> <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">+</span> <span class="n">y</span><span class="p">;</span> <span class="p">}</span>
|
|
|
|
<span class="k">auto</span> <span class="n">add2</span> <span class="o">=</span> <span class="p">[](</span><span class="kt">int</span> <span class="n">x</span><span class="p">,</span> <span class="kt">int</span> <span class="n">y</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">100</span> <span class="o">+</span> <span class="n">y</span><span class="p">;</span> <span class="p">};</span>
|
|
|
|
<span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">function_ref</span><span class="o"><</span><span class="kt">int</span><span class="p">(</span><span class="kt">int</span><span class="p">,</span> <span class="kt">int</span><span class="p">)</span><span class="o">>></span> <span class="n">fns</span><span class="p">;</span>
|
|
<span class="n">fns</span><span class="p">.</span><span class="n">push_back</span><span class="p">({</span><span class="n">add</span><span class="p">});</span>
|
|
<span class="n">fns</span><span class="p">.</span><span class="n">push_back</span><span class="p">({</span><span class="n">add2</span><span class="p">});</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span> <span class="n">fn</span> <span class="o">:</span> <span class="n">fns</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">fn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
|
|
<span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span><span class="o">...</span> <span class="nc">S</span><span class="p">></span>
|
|
<span class="k">struct</span> <span class="nc">function_ref</span><span class="p">;</span>
|
|
|
|
<span class="c1">// cv is either `const` or empty</span>
|
|
<span class="c1">// noex is either `true` or `false`</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">ArgTypes</span><span class="p">></span>
|
|
<span class="k">class</span> <span class="nc">function_ref</span><span class="o"><</span><span class="n">R</span><span class="p">(</span><span class="n">ArgTypes</span><span class="p">...)</span> <span class="n">cv</span> <span class="k">noexcept</span><span class="p">(</span><span class="n">noex</span><span class="p">)</span><span class="o">></span>
|
|
<span class="p">{</span>
|
|
<span class="nl">public:</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">F</span><span class="o">*</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">,</span> <span class="k">class</span> <span class="nc">U</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">,</span> <span class="n">U</span><span class="o">&&</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">,</span> <span class="n">cv</span> <span class="n">T</span><span class="o">*</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="n">function_ref</span><span class="p">(</span><span class="k">const</span> <span class="n">function_ref</span><span class="o">&</span><span class="p">)</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
<span class="n">function_ref</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="k">const</span> <span class="n">function_ref</span><span class="o">&</span><span class="p">)</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="n">function_ref</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">T</span><span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
|
|
<span class="n">R</span> <span class="k">operator</span><span class="p">()(</span><span class="n">ArgTypes</span><span class="p">...)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">(</span><span class="n">noex</span><span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_constructors">Constructors</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_function_pointer_constructor">Function Pointer Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">F</span><span class="o">*</span> <span class="n">fn</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>fn</code> != <code>nullptr</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a <code>function_ref</code> which uses the supplied function pointer as its Callable.<br></p>
|
|
<div class="paragraph">
|
|
<p>Calling the <code>function_ref</code> is expression-equivalent to <code>invoke_r<R>(f, call-args…​)</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_object_constructor">Object Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">fn</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a <code>function_ref</code> that stores the address of the supplied Callable object <code>fn</code>. This overload only
|
|
participates in resolution when <code>fn</code> is not a pointer-to-member or pointer-to-member-function.<br></p>
|
|
<div class="paragraph">
|
|
<p>Calling the <code>function_ref</code> is expression-equivalent to <code>invoke_r<R>(static_cast<cv T&>(f), call-args…​)</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_pointer_to_member_function_constructor">Pointer to Member Function Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a <code>function_ref</code> using the supplied pointer to member function. This overload only participates
|
|
in resolution when <code>f</code> is a pointer to member or pointer to member function.<br></p>
|
|
<div class="paragraph">
|
|
<p>Calling the <code>function_ref</code> is expression-equivalent to <code>invoke_r<R>(f, call-args)</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Example:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">struct</span> <span class="nc">point</span> <span class="p">{</span> <span class="kt">int</span> <span class="n">x</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> <span class="p">};</span>
|
|
|
|
<span class="n">point</span> <span class="n">p</span><span class="p">;</span>
|
|
<span class="n">compat</span><span class="o">::</span><span class="n">function_ref</span><span class="o"><</span><span class="kt">int</span><span class="p">(</span><span class="n">point</span> <span class="k">const</span><span class="o">&</span><span class="p">)</span><span class="o">></span> <span class="n">f</span><span class="p">(</span><span class="n">compat</span><span class="o">::</span><span class="n">nontype</span><span class="o"><&</span><span class="n">point</span><span class="o">::</span><span class="n">x</span><span class="o">></span><span class="p">);</span>
|
|
|
|
<span class="n">BOOST_TEST_EQ</span><span class="p">(</span><span class="n">f</span><span class="p">(</span><span class="n">p</span><span class="p">),</span> <span class="mi">1</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_bound_object_constructor">Bound Object Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">,</span> <span class="k">class</span> <span class="nc">U</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">,</span> <span class="n">U</span><span class="o">&&</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a <code>function_ref</code> using the supplied pointer to member or pointer to member function and a reference
|
|
to an object to bind it to.<br></p>
|
|
<div class="paragraph">
|
|
<p>This overload only participates in resolution if <code>is_rvalue_reference_v<U&&></code> is false.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Example:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">struct</span> <span class="nc">point</span> <span class="p">{</span> <span class="kt">int</span> <span class="n">x</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> <span class="p">};</span>
|
|
|
|
<span class="n">point</span> <span class="n">p</span><span class="p">;</span>
|
|
<span class="n">compat</span><span class="o">::</span><span class="n">function_ref</span><span class="o"><</span><span class="kt">int</span><span class="p">()</span><span class="o">></span> <span class="n">f</span><span class="p">(</span><span class="n">compat</span><span class="o">::</span><span class="n">nontype</span><span class="o"><&</span><span class="n">point</span><span class="o">::</span><span class="n">x</span><span class="o">></span><span class="p">,</span> <span class="n">p</span><span class="p">);</span>
|
|
|
|
<span class="n">BOOST_TEST_EQ</span><span class="p">(</span><span class="n">f</span><span class="p">(),</span> <span class="mi">1</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_bound_pointer_constructor">Bound Pointer Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">auto</span> <span class="n">f</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="n">function_ref</span><span class="p">(</span><span class="n">nontype_t</span><span class="o"><</span><span class="n">f</span><span class="o">></span><span class="p">,</span> <span class="n">cv</span> <span class="n">T</span><span class="o">*</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a <code>function_ref</code> using the supplied pointer to member or pointer to member function and a pointer
|
|
to an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Example:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">struct</span> <span class="nc">point</span> <span class="p">{</span> <span class="kt">int</span> <span class="n">x</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> <span class="p">};</span>
|
|
|
|
<span class="n">point</span> <span class="n">p</span><span class="p">;</span>
|
|
<span class="n">compat</span><span class="o">::</span><span class="n">function_ref</span><span class="o"><</span><span class="kt">int</span><span class="p">()</span><span class="o">></span> <span class="n">f</span><span class="p">(</span><span class="n">compat</span><span class="o">::</span><span class="n">nontype</span><span class="o"><&</span><span class="n">point</span><span class="o">::</span><span class="n">x</span><span class="o">></span><span class="p">,</span> <span class="o">&</span><span class="n">p</span><span class="p">);</span>
|
|
|
|
<span class="n">BOOST_TEST_EQ</span><span class="p">(</span><span class="n">f</span><span class="p">(),</span> <span class="mi">1</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_copy_constructor">Copy Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">function_ref</span><span class="p">(</span><span class="k">const</span> <span class="n">function_ref</span><span class="o">&</span><span class="p">)</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>function_ref</code> is a TriviallyCopyable type.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_member_functions">Member Functions</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_call_operator">call operator</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">R</span> <span class="nf">operator</span><span class="p">()(</span><span class="n">ArgTypes</span><span class="p">...)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">(</span><span class="n">noex</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Invokes the underlying Callable object by forwarding the supplied arguments.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_function_ref_assignment">Assignment</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_function_ref_copy_assignment">Copy Assignment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">function_ref</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="k">const</span> <span class="n">function_ref</span><span class="o">&</span><span class="p">)</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="n">function_ref</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">T</span><span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>operator=(T)</code> participates in overload resolution if:</p>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>T</code> is not the same as <code>function_ref</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>is_pointer_v<T></code> is <code>false</code>.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="integer_sequence"><boost/compat/integer_sequence.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/integer_sequence.hpp></code> implements the C++14 utilities
|
|
<code>std::integer_sequence</code>, <code>std::index_sequence</code>, <code>std::make_integer_sequence</code>,
|
|
<code>std::make_index_sequence</code>, and <code>std::index_sequence_for</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">T</span><span class="p">...</span> <span class="n">I</span><span class="p">></span> <span class="k">struct</span> <span class="nc">integer_sequence</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">T</span> <span class="n">N</span><span class="p">></span> <span class="k">using</span> <span class="n">make_integer_sequence</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span><span class="p">...</span> <span class="n">I</span><span class="p">></span> <span class="k">using</span> <span class="n">index_sequence</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span> <span class="k">using</span> <span class="n">make_index_sequence</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span><span class="o">...</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">index_sequence_for</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_integer_sequence">integer_sequence</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">T</span><span class="p">...</span> <span class="n">I</span><span class="p">></span> <span class="k">struct</span> <span class="nc">integer_sequence</span> <span class="p">{};</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_make_integer_sequence">make_integer_sequence</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">T</span> <span class="n">N</span><span class="p">></span> <span class="k">using</span> <span class="n">make_integer_sequence</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>make_integer_sequence<T, N></code> is an alias for <code>integer_sequence<T, 0, 1, 2, …​, N-1></code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_index_sequence">index_sequence</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span><span class="p">...</span> <span class="n">I</span><span class="p">></span> <span class="k">using</span> <span class="n">index_sequence</span> <span class="o">=</span> <span class="n">integer_sequence</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span><span class="p">,</span> <span class="n">I</span><span class="p">...</span><span class="o">></span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_make_index_sequence">make_index_sequence</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span> <span class="k">using</span> <span class="n">make_index_sequence</span> <span class="o">=</span> <span class="n">make_integer_sequence</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span><span class="p">,</span> <span class="n">N</span><span class="o">></span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_integer_sequence_index_sequence_for">index_sequence_for</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span><span class="o">...</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">index_sequence_for</span> <span class="o">=</span> <span class="n">make_integer_sequence</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kt">size_t</span><span class="p">,</span> <span class="k">sizeof</span><span class="p">...(</span><span class="n">T</span><span class="p">)</span><span class="o">></span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="invoke"><boost/compat/invoke.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/invoke.hpp></code> implements the C++17 function
|
|
<code>std::invoke</code>, the C++23 function <code>std::invoke_r</code>, and the associated
|
|
utilities <code>invoke_result_t</code>, <code>is_invocable</code>, <code>is_invocable_r</code>,
|
|
<code>is_nothrow_invocable</code>, and <code>is_nothrow_invocable_r</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>invoke(f, a…​)</code> generally returns <code>f(a…​)</code>, but when <code>f</code> is a pointer to
|
|
member, it invokes it as if by returning <code>mem_fn(f)(a…​)</code>. This allows
|
|
functions, function objects, and pointers to members to be treated uniformly
|
|
by components such as <code>bind_front</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>invoke_r<R>(f, a…​)</code> returns <code>invoke(f, a…​)</code>, converted to <code>R</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">struct</span> <span class="nc">X</span>
|
|
<span class="p">{</span>
|
|
<span class="kt">void</span> <span class="n">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">a</span><span class="p">,</span> <span class="kt">int</span> <span class="n">b</span><span class="p">)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="kt">int</span> <span class="nf">main</span><span class="p">()</span>
|
|
<span class="p">{</span>
|
|
<span class="n">X</span> <span class="n">x</span><span class="p">;</span>
|
|
<span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">invoke</span><span class="p">(</span><span class="o">&</span><span class="n">X</span><span class="o">::</span><span class="n">f</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> <span class="c1">// calls x.f(1, 2)</span>
|
|
<span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="n">invoke</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">);</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">using</span> <span class="n">invoke_result_t</span> <span class="o">=</span> <span class="cm">/*...*/</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_invocable</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_nothrow_invocable</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="n">R</span> <span class="n">invoke_r</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">);</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_invocable_r</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_nothrow_invocable_r</span><span class="p">;</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_invoke">invoke</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">auto</span> <span class="n">invoke</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">(</span><span class="cm">/*...*/</span><span class="p">)</span> <span class="o">-></span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>std::forward<F>(f)(std::forward<A>(a)…​)</code>, when <code>f</code> is not a pointer to member;</p>
|
|
</li>
|
|
<li>
|
|
<p><code>mem_fn(f)(std::forward<A>(a)…​)</code>, otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Constraints:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>the return expression must be valid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Remarks:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>The return type is <code>decltype(r)</code>, and the <code>noexcept</code> clause is <code>noexcept(noexcept(r))</code>, where <code>r</code> is the return expression.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_invoke_result_t">invoke_result_t</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">using</span> <span class="n">invoke_result_t</span> <span class="o">=</span>
|
|
<span class="k">decltype</span><span class="p">(</span> <span class="n">invoke</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">declval</span><span class="o"><</span><span class="n">F</span><span class="o">></span><span class="p">(),</span> <span class="n">std</span><span class="o">::</span><span class="n">declval</span><span class="o"><</span><span class="n">A</span><span class="o">></span><span class="p">()...)</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_is_invocable">is_invocable</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_invocable</span><span class="o">:</span> <span class="k">public</span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The base class of <code>is_invocable<F, A…​></code> is <code>std::true_type</code> when <code>invoke(std::declval<F>(), std::declval<A>()…​)</code> is a valid expression, <code>std::false_type</code> otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_is_nothrow_invocable">is_nothrow_invocable</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_nothrow_invocable</span><span class="o">:</span> <span class="k">public</span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The base class of <code>is_nothrow_invocable<F, A…​></code> is <code>std::false_type</code> when <code>is_invocable<F, A…​>::value</code> is <code>false</code>, <code>std::integral_constant<bool, noexcept(invoke(std::declval<F>(), std::declval<A>()…​))></code> otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_invoke_r">invoke_r</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="n">R</span> <span class="nf">invoke_r</span><span class="p">(</span><span class="n">F</span><span class="o">&&</span> <span class="n">f</span><span class="p">,</span> <span class="n">A</span><span class="o">&&</span><span class="p">...</span> <span class="n">a</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">(</span><span class="cm">/*...*/</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>static_cast<R>(invoke(std::forward<F>(f), std::forward<A>(a)…​))</code>, when <code>R</code> is (possibly cv-qualified) <code>void</code>;</p>
|
|
</li>
|
|
<li>
|
|
<p><code>invoke(std::forward<F>(f), std::forward<A>(a)…​)</code>, implicitly converted to <code>R</code>, otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Constraints:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>is_invocable<F, A…​>::value</code> must be <code>true</code> and, if <code>R</code> is not cv <code>void</code>, <code>std::is_convertible<invoke_result_t<F, A…​>, R>::value</code> must be <code>true</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Remarks:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>The <code>noexcept</code> clause is <code>noexcept(noexcept(static_cast<R>(invoke(std::forward<F>(f), std::forward<A>(a)…​))))</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_is_invocable_r">is_invocable_r</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_invocable</span><span class="o">:</span> <span class="k">public</span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The base class of <code>is_invocable_r<R, F, A…​></code> is <code>std::true_type</code> when <code>invoke_r<R>(std::declval<F>(), std::declval<A>()…​)</code> is a valid expression, <code>std::false_type</code> otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_invoke_is_nothrow_invocable_r">is_nothrow_invocable_r</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">,</span> <span class="k">class</span><span class="o">...</span> <span class="nc">A</span><span class="p">></span> <span class="k">struct</span> <span class="nc">is_nothrow_invocable</span><span class="o">:</span> <span class="k">public</span> <span class="cm">/*...*/</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The base class of <code>is_nothrow_invocable<R, F, A…​></code> is <code>std::false_type</code> when <code>is_invocable_r<R, F, A…​>::value</code> is <code>false</code>, <code>std::integral_constant<bool, noexcept(invoke_r<R>(std::declval<F>(), std::declval<A>()…​))></code> otherwise.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="latch"><boost/compat/latch.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_latch_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/latch.hpp></code> implements, in a portable way, the C++20
|
|
<code><latch></code> header.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>latch</code> is a single-use barrier which counts downwards, enabling synchronization
|
|
between a set of threads. The counter can be manually decremented by any value,
|
|
but decrementing below zero causes undefined behavior. The maximum number of waiters is
|
|
specified to be <code>boost::compat::latch::max()</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_latch_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="k">const</span> <span class="n">num_threads</span> <span class="o">=</span> <span class="mi">16</span><span class="p">;</span>
|
|
<span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">latch</span> <span class="nf">l</span><span class="p">(</span><span class="n">num_threads</span><span class="p">);</span>
|
|
|
|
<span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o"><</span><span class="n">std</span><span class="o">::</span><span class="kr">thread</span><span class="o">></span> <span class="n">threads</span><span class="p">;</span>
|
|
<span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">num_threads</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="n">threads</span><span class="p">.</span><span class="n">emplace_back</span><span class="p">([</span><span class="o">&</span><span class="n">l</span><span class="p">]</span> <span class="p">{</span>
|
|
<span class="c1">// do some preliminary work here...</span>
|
|
|
|
<span class="c1">// block until all threads have reached this statement</span>
|
|
<span class="n">l</span><span class="p">.</span><span class="n">arrive_and_wait</span><span class="p">();</span>
|
|
|
|
<span class="c1">// continue with further work...</span>
|
|
<span class="p">});</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">for</span> <span class="p">(</span><span class="k">auto</span><span class="o">&</span> <span class="n">t</span><span class="o">:</span> <span class="n">threads</span><span class="p">)</span> <span class="p">{</span> <span class="n">t</span><span class="p">.</span><span class="n">join</span><span class="p">();</span> <span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_latch_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">class</span> <span class="nc">latch</span> <span class="p">{</span>
|
|
<span class="k">explicit</span> <span class="n">latch</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">expected</span><span class="p">);</span>
|
|
|
|
<span class="n">latch</span><span class="p">(</span><span class="n">latch</span> <span class="k">const</span> <span class="o">&</span><span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
<span class="n">latch</span> <span class="o">&</span><span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">latch</span> <span class="k">const</span> <span class="o">&</span><span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
|
|
<span class="o">~</span><span class="n">latch</span><span class="p">()</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
|
|
<span class="kt">void</span> <span class="n">count_down</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">1</span><span class="p">);</span>
|
|
<span class="kt">bool</span> <span class="n">try_wait</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="kt">void</span> <span class="n">wait</span><span class="p">()</span> <span class="k">const</span><span class="p">;</span>
|
|
<span class="kt">void</span> <span class="n">arrive_and_wait</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">1</span><span class="p">);</span>
|
|
|
|
<span class="k">static</span> <span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">max</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_latch_constructors">Constructors</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_counter_constructor">Counter Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">explicit</span> <span class="nf">latch</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">expected</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>expected >= 0 && expected <= boost::compat::latch::max()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs a latch with an internal counter value of <code>expected</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_copy_constructor">Copy Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">latch</span><span class="p">(</span><span class="n">latch</span> <span class="k">const</span> <span class="o">&</span><span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>latch</code> is not copyable or movable.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_latch_member_functions">Member Functions</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_count_down">count_down</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="nf">count_down</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">1</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>n</code> must not be larger than the current internal counter’s value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Decrements the internal counter by <code>n</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_try_wait">try_wait</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">bool</span> <span class="n">try_wait</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Returns a boolean indicating whether or not the latch’s internal counter has reached 0 (<code>true</code>) or not (<code>false</code>).</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_wait">wait</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="n">wait</span><span class="p">()</span> <span class="k">const</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Blocks the current thread until the internal counter has reached 0.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_arrive_and_wait">arrive_and_wait</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="nf">arrive_and_wait</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">1</span><span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>n</code> must not be larger than the current internal counter’s value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Decrements the internal counter by <code>n</code> and if the counter non-zero, blocks the current thread.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_latch_max">max</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">static</span> <span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="kt">ptrdiff_t</span> <span class="n">max</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Returns an implementation-defined number representing the maximum amount of waiters. Currently PTRDIFF_MAX.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="mem_fn"><boost/compat/mem_fn.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_mem_fn_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/mem_fn.hpp></code> implements the C++11 function
|
|
<code>std::mem_fn</code>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>mem_fn(pm)</code>, where <code>pm</code> is a pointer to member, returns a function object
|
|
that can be used to invoke the member function, or obtain a reference to the
|
|
data member, using a function call syntax.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Even though <code>std::mem_fn</code> is C++11, later standards place stricter
|
|
requirements on the returned function object (it needs to be SFINAE friendly
|
|
and propagate <code>noexcept</code> correctly.) <code>boost::compat::mem_fn</code> implements
|
|
these stricter requirements.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_mem_fn_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">struct</span> <span class="nc">X</span>
|
|
<span class="p">{</span>
|
|
<span class="kt">void</span> <span class="n">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">a</span><span class="p">,</span> <span class="kt">int</span> <span class="n">b</span><span class="p">)</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="kt">int</span> <span class="nf">main</span><span class="p">()</span>
|
|
<span class="p">{</span>
|
|
<span class="k">auto</span> <span class="n">fn</span> <span class="o">=</span> <span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">mem_fn</span><span class="p">(</span><span class="o">&</span><span class="n">X</span><span class="o">::</span><span class="n">f</span><span class="p">);</span>
|
|
|
|
<span class="n">X</span> <span class="n">x</span><span class="p">;</span>
|
|
<span class="n">fn</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">);</span> <span class="c1">// calls x.f(1, 2)</span>
|
|
<span class="p">}</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_mem_fn_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">M</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">auto</span> <span class="n">mem_fn</span><span class="p">(</span><span class="n">M</span> <span class="n">T</span><span class="o">::*</span> <span class="n">pm</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_mem_fn_mem_fn">mem_fn</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">M</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">auto</span> <span class="n">mem_fn</span><span class="p">(</span><span class="n">M</span> <span class="n">T</span><span class="o">::*</span> <span class="n">pm</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>A function object <code>fn</code> such that:</p>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>fn(x, a…​)</code> is equivalent to <code>(x.*pm)(a…​)</code>, when <code>M</code> is a function type and the type of <code>X</code> is <code>T</code> or derived from <code>T</code>;</p>
|
|
</li>
|
|
<li>
|
|
<p><code>fn(x, a…​)</code> is equivalent to <code>((*x).*pm)(a…​)</code>, when <code>M</code> is a function type and the type of <code>X</code> is not <code>T</code> or derived from <code>T</code>;</p>
|
|
</li>
|
|
<li>
|
|
<p><code>fn(x)</code> is equivalent to <code>x.*pm</code>, when <code>M</code> is an object type and the type of <code>X</code> is <code>T</code> or derived from <code>T</code>;</p>
|
|
</li>
|
|
<li>
|
|
<p><code>fn(x)</code> is equivalent to <code>(*x).*pm</code>, when <code>M</code> is an object type and the type of <code>X</code> is not <code>T</code> or derived from <code>T</code>.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="move_only_function"><boost/compat/move_only_function.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/move_only_function.hpp></code> implements the C++23 class <a href="https://en.cppreference.com/w/cpp/utility/functional/move_only_function.html">std::move_only_function</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>move_only_function</code> is a polymorphic wrapper that stores and manages a <a href="https://en.cppreference.com/w/cpp/named_req/Callable">Callable</a>, only requiring that the type supports move construction and move assignment.
|
|
This is in contrast to the commonly used <code>std::function</code> which requires copyability of the underlying managed object.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>move_only_function</code> supports every combination of <code>const</code>, <code>noexcept</code> and reference qualification (none, <code>&</code>, <code>&&</code>).</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">struct</span> <span class="nc">moveonly</span>
|
|
<span class="p">{</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">unique_ptr</span><span class="o"><</span><span class="kt">int</span><span class="o">></span> <span class="n">p_</span> <span class="o">=</span> <span class="n">std</span><span class="o">::</span><span class="n">make_unique</span><span class="o"><</span><span class="kt">int</span><span class="o">></span><span class="p">(</span> <span class="mi">1234</span> <span class="p">);</span>
|
|
<span class="k">auto</span> <span class="k">operator</span><span class="p">()(</span> <span class="kt">int</span> <span class="n">x</span> <span class="p">)</span> <span class="k">noexcept</span> <span class="p">{</span> <span class="k">return</span> <span class="o">*</span><span class="n">p_</span> <span class="o">+</span> <span class="n">x</span><span class="p">;</span> <span class="p">}</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">move_only_function</span><span class="o"><</span><span class="kt">int</span><span class="p">(</span> <span class="kt">int</span> <span class="p">)</span> <span class="k">noexcept</span><span class="o">></span> <span class="n">f</span><span class="p">(</span> <span class="n">moveonly</span><span class="p">{}</span> <span class="p">);</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">cout</span> <span class="o"><<</span> <span class="n">f</span><span class="p">(</span> <span class="mi">4321</span> <span class="p">)</span> <span class="o"><<</span> <span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span> <span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span> <span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span><span class="o">...</span> <span class="nc">S</span><span class="p">></span>
|
|
<span class="k">class</span> <span class="nc">move_only_function</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span> <span class="k">class</span> <span class="nc">T</span> <span class="p">></span>
|
|
<span class="k">struct</span> <span class="nc">in_place_type_t</span> <span class="p">{</span> <span class="k">explicit</span> <span class="n">in_place_type_t</span><span class="p">()</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span> <span class="p">};</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">R</span><span class="p">,</span> <span class="k">class</span> <span class="o">...</span><span class="nc">Args</span><span class="p">></span>
|
|
<span class="k">class</span> <span class="nc">move_only_function</span><span class="o"><</span><span class="n">R</span><span class="p">(</span> <span class="n">Args</span><span class="p">...</span> <span class="p">)</span> <span class="cm">/* cv */</span> <span class="cm">/* ref */</span> <span class="k">noexcept</span><span class="p">(</span> <span class="cm">/* noex */</span><span class="p">)</span><span class="o">></span>
|
|
<span class="p">{</span>
|
|
<span class="n">move_only_function</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="n">move_only_function</span><span class="p">(</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span>
|
|
<span class="n">move_only_function</span><span class="p">(</span> <span class="n">F</span><span class="o">&&</span> <span class="n">f</span> <span class="p">);</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="o">...</span><span class="nc">CArgs</span><span class="p">></span>
|
|
<span class="k">explicit</span> <span class="n">move_only_function</span><span class="p">(</span> <span class="n">in_place_type_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">CArgs</span><span class="o">&&</span> <span class="p">...</span> <span class="n">args</span> <span class="p">);</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="nc">U</span><span class="p">,</span> <span class="k">class</span> <span class="o">...</span><span class="nc">CArgs</span><span class="p">></span>
|
|
<span class="k">explicit</span> <span class="n">move_only_function</span><span class="p">(</span> <span class="n">in_place_type_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o"><</span><span class="n">U</span><span class="o">></span> <span class="n">il</span><span class="p">,</span> <span class="n">CArgs</span><span class="o">&&</span> <span class="p">...</span> <span class="n">args</span> <span class="p">);</span>
|
|
|
|
<span class="n">move_only_function</span><span class="p">(</span> <span class="n">move_only_function</span> <span class="k">const</span><span class="o">&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
<span class="n">move_only_function</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
|
|
<span class="o">~</span><span class="n">move_only_function</span><span class="p">()</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
|
|
<span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&&</span> <span class="n">rhs</span> <span class="p">);</span>
|
|
<span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">F</span><span class="o">&&</span> <span class="n">f</span> <span class="p">);</span>
|
|
|
|
<span class="k">friend</span> <span class="kt">bool</span> <span class="k">operator</span><span class="o">==</span><span class="p">(</span> <span class="n">move_only_function</span> <span class="k">const</span><span class="o">&</span> <span class="n">fn</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">friend</span> <span class="kt">bool</span> <span class="k">operator</span><span class="o">!=</span><span class="p">(</span> <span class="n">move_only_function</span> <span class="k">const</span><span class="o">&</span> <span class="n">fn</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">rhs</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">friend</span> <span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">rhs</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="k">explicit</span> <span class="k">operator</span> <span class="kt">bool</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="n">R</span> <span class="k">operator</span><span class="p">()(</span> <span class="n">Args</span><span class="p">...</span> <span class="n">args</span> <span class="p">)</span> <span class="cm">/* cv */</span> <span class="cm">/* ref */</span> <span class="k">noexcept</span><span class="p">(</span> <span class="cm">/* noex */</span> <span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_constructors">Constructors</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_default_constructor">Default Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">move_only_function</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs an empty <code>move_only_function</code> which manages no object.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_null_constructor">Null Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">move_only_function</span><span class="p">(</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Explicitly constructs an empty <code>move_only_function</code> using a nullptr value. Equivalent to default construction.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_object_constructor">Object Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span>
|
|
<span class="n">move_only_function</span><span class="p">(</span> <span class="n">F</span><span class="o">&&</span> <span class="n">f</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Given <code>using VT = decay_t<F></code>, directly constructs an instance of <code>VT</code> using <code>forward<F>(f)</code> and stores it as the target object.<br></p>
|
|
<div class="paragraph">
|
|
<p>If <code>F</code> is an empty function pointer, pointer-to-member or specialization of <code>move_only_function</code> then the constructed <code>move_only_function</code> is empty.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Constraints:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>remove_cv_ref<F></code> is not the same type as <code>move_only_function</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>remove_cv_ref<F></code> is not a specialization of <code>in_place_type_t</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>VT</code> must be callable with the provided cvref qualifiers and the provided argument types</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_in_place_constructor">In-Place Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="o">...</span><span class="nc">CArgs</span><span class="p">></span>
|
|
<span class="k">explicit</span> <span class="nf">move_only_function</span><span class="p">(</span> <span class="n">in_place_type_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">CArgs</span><span class="o">&&</span> <span class="p">...</span> <span class="n">args</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs an object of type <code>T</code> using the provided args directly, storing it as the target object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Constraints:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>is_constructible_v<T, CArgs…​></code> must be true</p>
|
|
</li>
|
|
<li>
|
|
<p><code>T</code> must be callable with the provided cvref qualifiers and the provided argument types</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_list_in_place_constructor">List In-Place Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="nc">U</span><span class="p">,</span> <span class="k">class</span> <span class="o">...</span><span class="nc">CArgs</span><span class="p">></span>
|
|
<span class="k">explicit</span> <span class="nf">move_only_function</span><span class="p">(</span> <span class="n">in_place_type_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">initializer_list</span><span class="o"><</span><span class="n">U</span><span class="o">></span> <span class="n">il</span><span class="p">,</span> <span class="n">CArgs</span><span class="o">&&</span> <span class="p">...</span> <span class="n">args</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Constructs an object of type <code>T</code> using the provided initializer_list and args directly, storing it as the target Callable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Constraints:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>is_constructible_v<T, std::initializer_list<U>&, CArgs…​></code> must be true</p>
|
|
</li>
|
|
<li>
|
|
<p><code>T</code> must be callable with the provided cvref qualifiers and the provided argument types</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_move_constructor">Move Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">move_only_function</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&&</span> <span class="n">f</span> <span class="p">)</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Tranfers ownership of the object managed by <code>f</code> to <code>*this</code>. After this operation completes, <code>f</code> is empty and manages no object.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_assignment">Assignment</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_move_assignment">Move Assignment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&&</span> <span class="n">rhs</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Releases the currently managed object and takes ownership of the object managed by <code>rhs</code>, if applicable.
|
|
<code>rhs</code> is empty after move.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_null_assigment">Null Assigment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Releases the currently managed object, if applicable.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_callable_assignment">Callable Assignment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="n">move_only_function</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">F</span><span class="o">&&</span> <span class="n">f</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Releases the currently managed object and then does the equivalent of: <code>move_only_function(std::forward<F>(f)).swap(*this)</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_utility">Utility</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_null_equality">Null Equality</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">friend</span> <span class="kt">bool</span> <span class="k">operator</span><span class="o">==</span><span class="p">(</span> <span class="n">move_only_function</span> <span class="k">const</span><span class="o">&</span> <span class="n">fn</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">friend</span> <span class="kt">bool</span> <span class="k">operator</span><span class="o">!=</span><span class="p">(</span> <span class="n">move_only_function</span> <span class="k">const</span><span class="o">&</span> <span class="n">fn</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">nullptr_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Returns whether or not <code>fn</code> contains a target object.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_swap">Swap</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">rhs</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">friend</span> <span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">lhs</span><span class="p">,</span> <span class="n">move_only_function</span><span class="o">&</span> <span class="n">rhs</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Exchanges the managed objects.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_move_only_function_invocation">Invocation</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_boolean_conversion">Boolean Conversion</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">explicit</span> <span class="k">operator</span> <span class="kt">bool</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Returns <code>true</code> if <code>*this</code> is managing an object, or <code>false</code> if <code>*this</code> is empty.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_move_only_function_call_operator">Call Operator</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">R</span> <span class="nf">operator</span><span class="p">()(</span> <span class="n">Args</span><span class="p">...</span> <span class="n">args</span> <span class="p">)</span> <span class="cm">/* cv */</span> <span class="cm">/* ref */</span> <span class="k">noexcept</span><span class="p">(</span> <span class="cm">/* noex */</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>*this</code> currently manages an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Invokes the underlying target object. Equivalent to:</p>
|
|
<div class="openblock">
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">return</span> <span class="n">INVOKE</span><span class="o"><</span><span class="n">R</span><span class="o">></span><span class="p">(</span><span class="k">static_cast</span><span class="o"><</span><span class="n">F</span> <span class="n">inv</span><span class="o">-</span><span class="n">quals</span><span class="o">></span><span class="p">(</span><span class="n">f</span><span class="p">),</span> <span class="n">std</span><span class="o">::</span><span class="n">forward</span><span class="o"><</span><span class="n">Args</span><span class="o">></span><span class="p">(</span><span class="n">args</span><span class="p">)...);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>where <code>f</code> is the target object, and <em>inv-quals</em> is defined by the standard:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>If <em>ref</em> is empty, let <em>inv-quals</em> be <em>cv&</em>,</p>
|
|
</li>
|
|
<li>
|
|
<p>otherwise, let <em>inv-quals</em> be <em>cv ref</em>.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="shared_lock"><boost/compat/shared_lock.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/shared_lock.hpp></code> implements, in a portable way, the C++14
|
|
<code>std::shared_lock</code> class template.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The class <code>shared_lock</code> is a RAII wrapper that manages locking and unlocking
|
|
the provided Mutex, provided that it implements <a href="https://en.cppreference.com/w/cpp/named_req/SharedLockable">SharedLockable</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This is the shared analog of <a href="https://en.cppreference.com/w/cpp/thread/unique_lock">unique_lock</a>
|
|
and calls <code>lock_shared()</code> instead of <code>lock()</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="cp">#include</span> <span class="cpf"><boost/compat/shared_lock.hpp></span><span class="cp">
|
|
</span>
|
|
<span class="n">shared_mutex</span> <span class="n">m</span><span class="p">;</span>
|
|
|
|
<span class="c1">// acquire the lock by calling `m.lock_shared()`</span>
|
|
<span class="c1">// `m.unlock_shared()` is called automatically for us by `guard` now</span>
|
|
<span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">shared_lock</span><span class="o"><</span><span class="n">shared_mutex</span><span class="o">></span> <span class="n">guard</span><span class="p">(</span><span class="n">m</span><span class="p">);</span>
|
|
<span class="n">assert</span><span class="p">(</span><span class="n">guard</span><span class="p">.</span><span class="n">owns_lock</span><span class="p">());</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span> <span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span> <span class="p">{</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">Mutex</span><span class="p">></span>
|
|
<span class="k">class</span> <span class="nc">shared_lock</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">Mutex</span><span class="p">></span>
|
|
<span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o"><</span><span class="n">Mutex</span><span class="o">>&</span> <span class="n">x</span><span class="p">,</span> <span class="n">shared_lock</span><span class="o"><</span><span class="n">Mutex</span><span class="o">>&</span> <span class="n">y</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">Mutex</span><span class="p">></span>
|
|
<span class="k">class</span> <span class="nc">shared_lock</span> <span class="p">{</span>
|
|
<span class="k">using</span> <span class="n">mutex_type</span> <span class="o">=</span> <span class="n">Mutex</span><span class="p">;</span>
|
|
|
|
<span class="n">shared_lock</span><span class="p">()</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
|
|
<span class="k">explicit</span> <span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span> <span class="p">);</span>
|
|
<span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">defer_lock_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">try_lock_t</span> <span class="p">);</span>
|
|
<span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">adopt_lock_t</span> <span class="p">);</span>
|
|
|
|
<span class="o">~</span><span class="n">shared_lock</span><span class="p">();</span>
|
|
|
|
<span class="n">shared_lock</span><span class="p">(</span> <span class="k">const</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
<span class="n">shared_lock</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="k">const</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span>
|
|
|
|
<span class="n">shared_lock</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="n">shared_lock</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="kt">void</span> <span class="n">lock</span><span class="p">();</span>
|
|
<span class="kt">bool</span> <span class="n">try_lock</span><span class="p">();</span>
|
|
<span class="kt">void</span> <span class="n">unlock</span><span class="p">();</span>
|
|
|
|
<span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="n">mutex_type</span><span class="o">*</span> <span class="n">release</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="n">mutex_type</span><span class="o">*</span> <span class="n">mutex</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="kt">bool</span> <span class="n">owns_lock</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="k">explicit</span> <span class="k">operator</span> <span class="kt">bool</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_constructors">Constructors</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_default_constructor">Default Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">()</span> <span class="k">noexcept</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == nullptr</code> and <code>owns_lock() == false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_locking_constructor">Locking Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">explicit</span> <span class="nf">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Calls <code>m.lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == std::addressof(m)</code> and <code>owns_lock() == true</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_deferred_constructor">Deferred Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">defer_lock_t</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == std::addressof(m)</code> and <code>owns_lock() == false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_try_to_lock_constructor">Try-to-Lock Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">try_lock_t</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Calls <code>m.try_lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == std::addressof(m)</code> and <code>owns_lock() == res</code> where
|
|
<code>res</code> is the result of the <code>m.try_lock_shared()</code> call.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_adopting_constructor">Adopting Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">(</span> <span class="n">mutex_type</span><span class="o">&</span> <span class="n">m</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">adopt_lock_t</span> <span class="p">);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Preconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>m</code> must be held by a previous call to <code>m.lock_shared()</code> or a
|
|
successful call to <code>m.try_lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == std::addressof(m)</code> and <code>owns_lock() == true</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_copy_constructor">Copy Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">(</span> <span class="k">const</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>shared_lock</code> is not copyable.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_move_constructor">Move Constructor</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == s.mutex()</code> and <code>owns_lock() == s.owns_lock()</code> where
|
|
<code>s</code> is the state of <code>u</code> before move. <code>u.mutex() == nullptr</code> and <code>u.owns_lock() == false</code>
|
|
after move.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_assignment">Assignment</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_copy_assignment">Copy Assignment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="k">const</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="p">)</span> <span class="o">=</span> <span class="k">delete</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>shared_lock</code> is not copyable.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_move_assignment">Move Assignment</h4>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">shared_lock</span><span class="o">&</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>If <code>owns_lock() == true</code>, calls <code>unlock()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == s.mutex()</code> and <code>owns_lock() == s.owns_lock()</code> where
|
|
<code>s</code> is the state of <code>u</code> before move. <code>u.mutex() == nullptr</code> and <code>u.owns_lock() == false</code>
|
|
after move.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_destructor">Destructor</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="o">~</span><span class="n">shared_lock</span><span class="p">();</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>If <code>owns_lock() == true</code>, calls <code>unlock()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_shared_lock_member_functions">Member Functions</h3>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_locking">Locking</h4>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_lock">lock</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="nf">lock</span><span class="p">();</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Calls <code>mutex()->lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>owns_lock() == true</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Throws:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Any exception caused by <code>mutex()->lock_shared()</code>. <code>std::system_error</code>
|
|
when <code>mutex() == nullptr</code> (with <code>std::errc::operation_not_permitted</code>) or
|
|
<code>owns_lock() == true</code> (with <code>std::errc::resource_deadlock_would_occur</code>).</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_try_lock">try_lock</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">bool</span> <span class="nf">try_lock</span><span class="p">();</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Calls <code>mutex()->try_lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>owns_lock() == res</code> where <code>res = mutex()->try_lock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Throws:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Any exception caused by <code>mutex()->try_lock_shared()</code>. <code>std::system_error</code>
|
|
when <code>mutex() == nullptr</code> (with <code>std::errc::operation_not_permitted</code>) or
|
|
<code>owns_lock() == true</code> (with <code>std::errc::resource_deadlock_would_occur</code>).</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_unlock">unlock</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="nf">unlock</span><span class="p">();</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Calls <code>mutex()->unlock_shared()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>owns_lock() == false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Throws:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>std::system_error</code> (with <code>std::errc::operation_not_permitted</code>) if <code>owns_lock() == false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_modifiers">Modifiers</h4>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_swap">swap</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o">&</span> <span class="n">u</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Swaps the data members of <code>*this</code> and <code>u</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_release">release</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">mutex_type</span><span class="o">*</span> <span class="n">release</span><span class="p">()</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Postconditions:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>mutex() == nullptr</code> and <code>owns_lock() == false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>The previous value of <code>mutex()</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_free_function_swap">Free Function swap</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">Mutex</span><span class="p">></span>
|
|
<span class="kt">void</span> <span class="n">swap</span><span class="p">(</span> <span class="n">shared_lock</span><span class="o"><</span><span class="n">Mutex</span><span class="o">>&</span> <span class="n">x</span><span class="p">,</span> <span class="n">shared_lock</span><span class="o"><</span><span class="n">Mutex</span><span class="o">>&</span> <span class="n">y</span> <span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Swaps the data members of <code>x</code> and <code>y</code> via <code>x.swap(y)</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="ref_shared_lock_observers">Observers</h4>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_mutex">mutex</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="n">mutex_type</span><span class="o">*</span> <span class="n">mutex</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>The value of the internal pointer, either <code>nullptr</code> or the address of
|
|
the mutex.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_owns_lock">owns_lock</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">bool</span> <span class="n">owns_lock</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>A boolean indicating whether or not the mutex is locked by the current
|
|
<code>shared_lock</code> instance.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="ref_shared_lock_boolean_conversion">boolean conversion</h5>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">explicit</span> <span class="k">operator</span> <span class="kt">bool</span><span class="p">()</span> <span class="k">const</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Returns:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>A boolean indicating whether or not the mutex is locked by the current
|
|
<code>shared_lock</code> instance.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="to_array"><boost/compat/to_array.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_to_array_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/to_array.hpp></code> implements, in a portable way, the C++20
|
|
<code>std::to_array</code> function, present in the <code><array></code> header.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>to_array</code> creates a <code>std::array</code> from a single-dimensional C array,
|
|
performing an element-wise copy or move.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_array_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="kt">int</span> <span class="n">input</span> <span class="p">[]</span> <span class="o">=</span> <span class="p">{</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">};</span>
|
|
<span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="kt">int</span><span class="p">,</span> <span class="mi">3</span><span class="o">></span> <span class="n">output</span> <span class="o">=</span> <span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">to_array</span><span class="p">(</span><span class="n">input</span><span class="p">);</span>
|
|
<span class="n">assert</span><span class="p">((</span>
|
|
<span class="n">output</span> <span class="o">==</span> <span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="kt">int</span><span class="p">,</span> <span class="mi">3</span><span class="o">></span><span class="p">{{</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">}}</span>
|
|
<span class="p">));</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_array_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">remove_cv_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="n">to_array</span><span class="p">(</span><span class="n">T</span> <span class="p">(</span><span class="o">&</span><span class="n">a</span><span class="p">)[</span><span class="n">N</span><span class="p">]);</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">remove_cv_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="n">to_array</span><span class="p">(</span><span class="n">T</span> <span class="p">(</span><span class="o">&&</span><span class="n">a</span><span class="p">)[</span><span class="n">N</span><span class="p">]);</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_array_to_array">to_array</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">remove_cv_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="n">to_array</span><span class="p">(</span><span class="n">T</span> <span class="p">(</span><span class="o">&&</span><span class="n">a</span><span class="p">)[</span><span class="n">N</span><span class="p">]);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Creates an array of <code>N</code> elements by copying elements in <code>a</code>.
|
|
For every <code>i</code> in <code>0, …​, N-1</code>, copy-initializes the i-th element
|
|
in the output array from <code>a[i]</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Type requirements:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>std::is_constructible_v<remove_cv_t<T>, T&> && !std::is_array_v<T></code>.
|
|
Otherwise, the overload is ill-formed.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="kt">size_t</span> <span class="n">N</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="n">std</span><span class="o">::</span><span class="n">array</span><span class="o"><</span><span class="n">remove_cv_t</span><span class="o"><</span><span class="n">T</span><span class="o">></span><span class="p">,</span> <span class="n">N</span><span class="o">></span> <span class="n">to_array</span><span class="p">(</span><span class="n">T</span> <span class="p">(</span><span class="o">&</span><span class="n">a</span><span class="p">)[</span><span class="n">N</span><span class="p">]);</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Creates an array of <code>N</code> elements by moving elements in <code>a</code>.
|
|
For every <code>i</code> in <code>0, …​, N-1</code>, move-initializes the i-th element
|
|
in the output array from <code>std::move(a[i])</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Type requirements:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>std::is_constructible_v<remove_cv_t<T>, T&&> && !std::is_array_v<T></code>.
|
|
Otherwise, the overload is ill-formed.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="to_underlying"><boost/compat/to_underlying.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_to_underlying_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/to_underlying.hpp></code> implements the C++23 function <a href="https://en.cppreference.com/w/cpp/utility/to_underlying.html">std::to_underlying</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>to_underlying</code> is a terse way of converting a value of enumeration type to its underlying type, avoiding accidental narrowing or widening. This function is ill-formed if the given value is not of enumeration type.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_underlying_example">Example</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">enum</span> <span class="n">e</span> <span class="o">:</span> <span class="n">std</span><span class="o">::</span><span class="kt">uint16_t</span>
|
|
<span class="p">{</span>
|
|
<span class="n">e_value</span> <span class="o">=</span> <span class="mi">5</span>
|
|
<span class="p">};</span>
|
|
<span class="k">auto</span> <span class="n">output</span> <span class="o">=</span> <span class="n">boost</span><span class="o">::</span><span class="n">compat</span><span class="o">::</span><span class="n">to_underlying</span><span class="p">(</span><span class="n">e_value</span><span class="p">);</span>
|
|
<span class="k">static_assert</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o"><</span><span class="k">decltype</span><span class="p">(</span><span class="n">output</span><span class="p">),</span> <span class="n">std</span><span class="o">::</span><span class="kt">uint16_t</span><span class="o">>::</span><span class="n">value</span><span class="p">);</span>
|
|
<span class="n">assert</span><span class="p">((</span>
|
|
<span class="n">output</span> <span class="o">==</span> <span class="mi">5</span>
|
|
<span class="p">));</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_underlying_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">E</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">underlying_type</span><span class="o"><</span><span class="n">E</span><span class="o">>::</span><span class="n">type</span> <span class="n">to_underlying</span><span class="p">(</span><span class="n">E</span> <span class="n">e</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span>
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_to_underlying_to_underlying">to_underlying</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="cpp"><span class="k">template</span> <span class="o"><</span><span class="k">class</span> <span class="nc">E</span><span class="p">></span>
|
|
<span class="k">constexpr</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">underlying_type</span><span class="o"><</span><span class="n">E</span><span class="o">>::</span><span class="n">type</span> <span class="n">to_underlying</span><span class="p">(</span><span class="n">E</span> <span class="n">e</span><span class="p">)</span> <span class="k">noexcept</span><span class="p">;</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="hdlist">
|
|
<table>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Effects:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p>Casts the value <code>e</code> of enumeration type <code>E</code> to its underlying type.
|
|
Equivalent to <code>static_cast<typename std::underlying_type<E>::type>(e)</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="hdlist1">
|
|
Type requirements:
|
|
</td>
|
|
<td class="hdlist2">
|
|
<p><code>std::is_enum<E>::value</code>.
|
|
Otherwise, the function is ill-formed.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="type_traits"><boost/compat/type_traits.hpp></h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="ref_type_traits_description">Description</h3>
|
|
<div class="paragraph">
|
|
<p>The header <code><boost/compat/type_traits.hpp></code> implements some of the
|
|
post-C++11 additions to the standard header <code><type_traits></code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="ref_type_traits_synopsis">Synopsis</h3>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="c++"><span class="cp">#include</span> <span class="cpf"><type_traits></span><span class="cp">
|
|
</span>
|
|
<span class="k">namespace</span> <span class="n">boost</span>
|
|
<span class="p">{</span>
|
|
<span class="k">namespace</span> <span class="n">compat</span>
|
|
<span class="p">{</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">remove_const_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">remove_const</span><span class="o"><</span><span class="n">T</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">remove_cv_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">remove_cv</span><span class="o"><</span><span class="n">T</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">remove_reference_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">remove_reference</span><span class="o"><</span><span class="n">T</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">remove_cvref_t</span> <span class="o">=</span> <span class="n">remove_cv_t</span><span class="o"><</span><span class="n">remove_reference_t</span><span class="o"><</span><span class="n">T</span><span class="o">>></span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">decay_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">decay</span><span class="o"><</span><span class="n">T</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="kt">bool</span> <span class="n">B</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span> <span class="o">=</span> <span class="kt">void</span><span class="p">></span> <span class="k">using</span> <span class="n">enable_if_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">enable_if</span><span class="o"><</span><span class="n">B</span><span class="p">,</span> <span class="n">T</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="kt">bool</span> <span class="n">B</span><span class="p">,</span> <span class="k">class</span> <span class="nc">T</span><span class="p">,</span> <span class="k">class</span> <span class="nc">F</span><span class="p">></span> <span class="k">using</span> <span class="n">conditional_t</span> <span class="o">=</span> <span class="k">typename</span> <span class="n">std</span><span class="o">::</span><span class="n">conditional</span><span class="o"><</span><span class="n">B</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">F</span><span class="o">>::</span><span class="n">type</span><span class="p">;</span>
|
|
|
|
<span class="k">template</span><span class="o"><</span><span class="k">class</span><span class="o">...</span> <span class="nc">T</span><span class="p">></span> <span class="k">using</span> <span class="n">void_t</span> <span class="o">=</span> <span class="kt">void</span><span class="p">;</span>
|
|
|
|
|
|
<span class="p">}</span> <span class="c1">// namespace compat</span>
|
|
<span class="p">}</span> <span class="c1">// namespace boost</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="copyright">Copyright and License</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>This documentation is copyright 2023, 2024 Peter Dimov and
|
|
contributors and is distributed under the
|
|
<a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated 2026-04-15 14:38:53 UTC
|
|
</div>
|
|
</div>
|
|
<style>
|
|
|
|
*:not(pre)>code { background: none; color: #600000; }
|
|
:not(pre):not([class^=L])>code { background: none; color: #600000; }
|
|
|
|
</style>
|
|
</body>
|
|
</html> |