forked from taskflow/taskflow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasstf_1_1SmallVector.html
188 lines (188 loc) · 12 KB
/
classtf_1_1SmallVector.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>tf::SmallVector class | Taskflow QuickStart</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<link rel="icon" href="favicon.ico" type="image/vnd.microsoft.icon" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>
</span>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="pages.html">Handbook</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<div class="m-doc-template">template<typename T, unsigned N = 2></div>
<span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>SmallVector <span class="m-thin">class</span>
</h1>
<p>class to define a vector optimized for small array</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">T</td>
<td>data type</td>
</tr>
<tr>
<td>N</td>
<td>threshold of the number of elements in the initial storage</td>
</tr>
</tbody>
</table>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
</ul>
</li>
</ul>
</nav>
<p>The class defines a C++ STL-styled vector (a variable-sized array) optimized for the case when the array is small. It contains some number of elements in-place, which allows it to avoid heap allocation when the actual number of elements is below that threshold. This allows normal <em>small</em> cases to be fast without losing generality for large inputs. All the methods in <a href="https://en.cppreference.com/w/cpp/container/vector">std::<wbr />vector</a> can apply to this class.</p><p>The class is stripped from the LLVM codebase.</p>
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
<dt id="a7948bf82d89a97740fc6ae7eb484a14d">
<span class="m-doc-wrap-bumper"><a href="#a7948bf82d89a97740fc6ae7eb484a14d" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>constructs an empty vector</dd>
<dt id="a092160eaf54d09827daaa8875c089226">
<span class="m-doc-wrap-bumper"><a href="#a092160eaf54d09827daaa8875c089226" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap">size_t Size,
const T& Value = T()) <span class="m-label m-flat m-info">explicit</span> </span>
</dt>
<dd>constructs a vector with <code>Size</code> copies of elements with value <code>value</code></dd>
<dt id="a0e0c9ea3b175d1e48e640434f9839380">
<div class="m-doc-template">template<typename ItTy></div>
<span class="m-doc-wrap-bumper"><a href="#a0e0c9ea3b175d1e48e640434f9839380" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap">ItTy S,
ItTy E)</span>
</dt>
<dd>constructs a vector with the contents of the range <code>[S, E)</code></dd>
<dt id="ad45a8ae1e4b0d313e56d84787e3d9c91">
<span class="m-doc-wrap-bumper"><a href="#ad45a8ae1e4b0d313e56d84787e3d9c91" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap"><a href="http://en.cppreference.com/w/cpp/utility/initializer_list.html" class="m-doc-external">std::<wbr />initializer_list</a><T> IL)</span>
</dt>
<dd>constructs a vector with the contents of the initializer list <code>IL</code></dd>
<dt id="a7a3ca548c2b19ce570265b6dad2dfff7">
<span class="m-doc-wrap-bumper"><a href="#a7a3ca548c2b19ce570265b6dad2dfff7" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>& RHS)</span>
</dt>
<dd>constructs the vector with the copy of the contents of <code>RHS</code></dd>
<dt id="acf74c15d1ba09f9d71e706859613c005">
<span class="m-doc-wrap-bumper"><a href="#acf74c15d1ba09f9d71e706859613c005" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&& RHS)</span>
</dt>
<dd>constructs the vector with the contents of <code>RHS</code> using move semantics</dd>
<dt id="a2507828c99bdc8d13cc57ec762689e2b">
<span class="m-doc-wrap-bumper"><a href="#a2507828c99bdc8d13cc57ec762689e2b" class="m-doc-self">SmallVector</a>(</span><span class="m-doc-wrap">SmallVectorImpl<T>&& RHS)</span>
</dt>
<dd>constructs a vector with the contents of <code>RHS</code> using move semantics</dd>
</dl>
</section>
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
<dt id="aa2a3549a42d052ecb9f9c348f547406e">
<span class="m-doc-wrap-bumper">auto <a href="#aa2a3549a42d052ecb9f9c348f547406e" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap">const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>& RHS) -> const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&</span>
</dt>
<dd>replaces the contents with a copy of the contents of <code>RHS</code></dd>
<dt id="a66c2613642723060c21f0539d4a86b2d">
<span class="m-doc-wrap-bumper">auto <a href="#a66c2613642723060c21f0539d4a86b2d" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&& RHS) -> const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&</span>
</dt>
<dd>replaces the contents with the contents of <code>RHS</code> using move semantics</dd>
<dt id="a06e0c4f610e6ede440b8f2ec38392781">
<span class="m-doc-wrap-bumper">auto <a href="#a06e0c4f610e6ede440b8f2ec38392781" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap">SmallVectorImpl<T>&& RHS) -> const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&</span>
</dt>
<dd>replaces the contents with the contents of <code>RHS</code> using move semantics</dd>
<dt id="a18276baf5b8c09d8452d198b5f568576">
<span class="m-doc-wrap-bumper">auto <a href="#a18276baf5b8c09d8452d198b5f568576" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="http://en.cppreference.com/w/cpp/utility/initializer_list.html" class="m-doc-external">std::<wbr />initializer_list</a><T> IL) -> const <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a>&</span>
</dt>
<dd>replaces the contents with the copy of the contents of an initializer list <code>IL</code></dd>
</dl>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form>
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
<p class="m-noindent">Search for symbols, directories, files, pages or
modules. You can omit any prefix from the symbol or file path; adding a
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
/ <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
copy a link to the result using <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018–2022.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.8.14 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>