cpp-taskflow/docs/annotated.html at master · aimoonchen/cpp-taskflow · GitHub

History

187 lines (187 loc) · 16.4 KB

Raw

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

<!DOCTYPE html>

<head>

<title>Taskflow QuickStart</title>

</head>

<body>

<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>

</svg></a>

</div>

<li><a href="pages.html">Handbook</a></li>

<li><a href="namespaces.html">Namespaces</a></li>

</ol>

<li><a href="annotated.html" id="m-navbar-current">Classes</a></li>

<li><a href="files.html">Files</a></li>

</svg></a></li>

</ol>

</div>

</nav></header>

<h1>Classes</h1>

<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacetf.html" class="m-doc">tf</a> <span class="m-doc">taskflow namespace</span>

<li>class <a href="classtf_1_1AsyncTask.html" class="m-doc">AsyncTask</a> <span class="m-doc">class to create a dependent asynchronous task (async task)</span></li>

<li>class <a href="classtf_1_1BoundedTaskQueue.html" class="m-doc">BoundedTaskQueue</a> <span class="m-doc">class to create a lock-free bounded work-stealing queue</span></li>

<li>struct <a href="structtf_1_1CachelineAligned.html" class="m-doc">CachelineAligned</a> <span class="m-doc">struct to ensure cacheline-aligned storage for an object.</span></li>

<li>class <a href="classtf_1_1ChromeObserver.html" class="m-doc">ChromeObserver</a> <span class="m-doc">class to create an observer based on Chrome tracing format</span></li>

<a href="#" onclick="return toggle(this)">class</a> <a href="classtf_1_1cudaDeviceAllocator.html" class="m-doc">cudaDeviceAllocator</a> <span class="m-doc">class to create a CUDA device allocator</span>

<li>struct <a href="structtf_1_1cudaDeviceAllocator_1_1rebind.html" class="m-doc">rebind</a> <span class="m-doc">its member type <code>U</code> is the equivalent allocator type to allocate elements of type U</span></li>

</ul>

</li>

<li>class <a href="classtf_1_1cudaEvent.html" class="m-doc">cudaEvent</a> <span class="m-doc">class to create an RAII-styled wrapper over a native CUDA event</span></li>

<li>class <a href="classtf_1_1cudaExecutionPolicy.html" class="m-doc">cudaExecutionPolicy</a> <span class="m-doc">class to define execution policy for CUDA standard algorithms</span></li>

<li>class <a href="classtf_1_1cudaFlow.html" class="m-doc">cudaFlow</a> <span class="m-doc">class to create a cudaFlow task dependency graph</span></li>

<li>class <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">cudaFlowCapturer</a> <span class="m-doc">class to create a cudaFlow graph using stream capture</span></li>

<li>class <a href="classtf_1_1cudaFlowLinearOptimizer.html" class="m-doc">cudaFlowLinearOptimizer</a> <span class="m-doc">class to capture a linear CUDA graph using a sequential stream</span></li>

<li>class <a href="classtf_1_1cudaFlowOptimizerBase.html" class="m-doc">cudaFlowOptimizerBase</a> <span class="m-doc">class to provide helper common methods for optimization algorithms</span></li>

<li>class <a href="classtf_1_1cudaFlowRoundRobinOptimizer.html" class="m-doc">cudaFlowRoundRobinOptimizer</a> <span class="m-doc">class to capture a CUDA graph using a round-robin algorithm</span></li>

<li>class <a href="classtf_1_1cudaFlowSequentialOptimizer.html" class="m-doc">cudaFlowSequentialOptimizer</a> <span class="m-doc">class to capture a CUDA graph using a sequential stream</span></li>

<li>class <a href="classtf_1_1cudaScopedDevice.html" class="m-doc">cudaScopedDevice</a> <span class="m-doc">class to create an RAII-styled context switch</span></li>

<li>class <a href="classtf_1_1cudaStream.html" class="m-doc">cudaStream</a> <span class="m-doc">class to create an RAII-styled wrapper over a native CUDA stream</span></li>

<li>class <a href="classtf_1_1cudaTask.html" class="m-doc">cudaTask</a> <span class="m-doc">class to create a task handle over an internal node of a cudaFlow graph</span></li>

<a href="#" onclick="return toggle(this)">class</a> <a href="classtf_1_1cudaUSMAllocator.html" class="m-doc">cudaUSMAllocator</a> <span class="m-doc">class to create a unified shared memory (USM) allocator</span>

<li>struct <a href="structtf_1_1cudaUSMAllocator_1_1rebind.html" class="m-doc">rebind</a> <span class="m-doc">its member type <code>U</code> is the equivalent allocator type to allocate elements of type U</span></li>

</ul>

</li>

<li>class <a href="classtf_1_1DataPipe.html" class="m-doc">DataPipe</a> <span class="m-doc">class to create a stage in a data-parallel pipeline</span></li>

<li>class <a href="classtf_1_1DataPipeline.html" class="m-doc">DataPipeline</a> <span class="m-doc">class to create a data-parallel pipeline scheduling framework</span></li>

<li>struct <a href="structtf_1_1DefaultClosureWrapper.html" class="m-doc">DefaultClosureWrapper</a> <span class="m-doc">default closure wrapper that simply runs the given closure as is</span></li>

<li>struct <a href="structtf_1_1DefaultTaskParams.html" class="m-doc">DefaultTaskParams</a> <span class="m-doc">empty task parameter type for compile-time optimization</span></li>

<li>class <a href="classtf_1_1DynamicPartitioner.html" class="m-doc">DynamicPartitioner</a> <span class="m-doc">class to construct a dynamic partitioner for scheduling parallel algorithms</span></li>

<li>class <a href="classtf_1_1Executor.html" class="m-doc">Executor</a> <span class="m-doc">class to create an executor</span></li>

<li>class <a href="classtf_1_1FlowBuilder.html" class="m-doc">FlowBuilder</a> <span class="m-doc">class to build a task dependency graph</span></li>

<li>class <a href="classtf_1_1Future.html" class="m-doc">Future</a> <span class="m-doc">class to access the result of an execution</span></li>

<li>class <a href="classtf_1_1Graph.html" class="m-doc">Graph</a> <span class="m-doc">class to create a graph object</span></li>

<li>class <a href="classtf_1_1GuidedPartitioner.html" class="m-doc">GuidedPartitioner</a> <span class="m-doc">class to construct a guided partitioner for scheduling parallel algorithms</span></li>

<li>class <a href="classtf_1_1IndexRange.html" class="m-doc">IndexRange</a> <span class="m-doc">class to create an index range of integral indices with a step size</span></li>

<li>class <a href="classtf_1_1ObserverInterface.html" class="m-doc">ObserverInterface</a> <span class="m-doc">class to derive an executor observer</span></li>

<li>class <a href="classtf_1_1PartitionerBase.html" class="m-doc">PartitionerBase</a> <span class="m-doc">class to derive a partitioner for scheduling parallel algorithms</span></li>

<li>class <a href="classtf_1_1Pipe.html" class="m-doc">Pipe</a> <span class="m-doc">class to create a pipe object for a pipeline stage</span></li>

<li>class <a href="classtf_1_1Pipeflow.html" class="m-doc">Pipeflow</a> <span class="m-doc">class to create a pipeflow object used by the pipe callable</span></li>

<li>class <a href="classtf_1_1Pipeline.html" class="m-doc">Pipeline</a> <span class="m-doc">class to create a pipeline scheduling framework</span></li>

<li>class <a href="classtf_1_1RandomPartitioner.html" class="m-doc">RandomPartitioner</a> <span class="m-doc">class to construct a random partitioner for scheduling parallel algorithms</span></li>

<li>class <a href="classtf_1_1Runtime.html" class="m-doc">Runtime</a> <span class="m-doc">class to include a runtime object in a task</span></li>

<li>class <a href="classtf_1_1ScalablePipeline.html" class="m-doc">ScalablePipeline</a> <span class="m-doc">class to create a scalable pipeline object</span></li>

<li>class <a href="classtf_1_1Semaphore.html" class="m-doc">Semaphore</a> <span class="m-doc">class to create a semophore object for building a concurrency constraint</span></li>

<li>class <a href="classtf_1_1SmallVector.html" class="m-doc">SmallVector</a> <span class="m-doc">class to define a vector optimized for small array</span></li>

<li>class <a href="classtf_1_1StaticPartitioner.html" class="m-doc">StaticPartitioner</a> <span class="m-doc">class to construct a static partitioner for scheduling parallel algorithms</span></li>

<li>class <a href="classtf_1_1Subflow.html" class="m-doc">Subflow</a> <span class="m-doc">class to construct a subflow graph from the execution of a dynamic task</span></li>

<li>class <a href="classtf_1_1Task.html" class="m-doc">Task</a> <span class="m-doc">class to create a task handle over a node in a taskflow graph</span></li>

<li>class <a href="classtf_1_1Taskflow.html" class="m-doc">Taskflow</a> <span class="m-doc">class to create a taskflow object</span></li>

<li>struct <a href="structtf_1_1TaskParams.html" class="m-doc">TaskParams</a> <span class="m-doc">task parameters to use when creating an asynchronous task</span></li>

<li>class <a href="classtf_1_1TaskView.html" class="m-doc">TaskView</a> <span class="m-doc">class to access task information from the observer interface</span></li>

<a href="#" onclick="return toggle(this)">class</a> <a href="classtf_1_1TFProfObserver.html" class="m-doc">TFProfObserver</a> <span class="m-doc">class to create an observer based on the built-in taskflow profiler format</span>

<li>struct <a href="structtf_1_1TFProfObserver_1_1TaskSummary.html" class="m-doc">TaskSummary</a> <span class="m-doc"></span></li>

<li>struct <a href="structtf_1_1TFProfObserver_1_1WorkerSummary.html" class="m-doc">WorkerSummary</a> <span class="m-doc"></span></li>

</ul>

</li>

<li>class <a href="classtf_1_1UnboundedTaskQueue.html" class="m-doc">UnboundedTaskQueue</a> <span class="m-doc">class to create a lock-free unbounded work-stealing queue</span></li>

<li>class <a href="classtf_1_1Worker.html" class="m-doc">Worker</a> <span class="m-doc">class to create a worker in an executor</span></li>

<li>class <a href="classtf_1_1WorkerInterface.html" class="m-doc">WorkerInterface</a> <span class="m-doc">class to configure worker behavior in an executor</span></li>

<li>class <a href="classtf_1_1WorkerView.html" class="m-doc">WorkerView</a> <span class="m-doc">class to create an immutable view of a worker</span></li>

</ul>

</li>

</ul>

function toggle(e) {

e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?

'm-doc-expansible' : 'm-doc-collapsible';

return false;

}

/* Collapse all nodes marked as such. Doing it via JS instead of

directly in markup so disabling it doesn't harm usability. The list

is somehow regenerated on every iteration and shrinks as I change

the classes. It's not documented anywhere and I'm not sure if this

is the same across browsers, so I am going backwards in that list to

be sure. */

var collapsed = document.getElementsByClassName("collapsed");

for(var i = collapsed.length - 1; i >= 0; --i)

collapsed[i].className = 'm-doc-expansible';

</script>

</div>

</article></main>

<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>

<form>

</form>

<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>

/ <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>

</div>

<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–2025.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.13.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>

</div>

</nav></footer>

</body>

</html>

cpp-taskflow/docs/annotated.html at master · aimoonchen/cpp-taskflow · GitHub

Expand file tree

Breadcrumbs

annotated.html

Latest commit

History

Breadcrumbs

annotated.html

File metadata and controls