taskflow/docs/annotated.html at master · taskflow/taskflow · GitHub

History

179 lines (177 loc) · 23.5 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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Taskflow: A General-purpose Task-parallel Programming System: Class List</title>

</head>

<body>

<tbody>

<div id="projectname"><a href="https://github.com/taskflow/taskflow" style="color:inherit; text-decoration:none;">Taskflow: A General-purpose Task-parallel Programming System</a>

</div>

</td>

</tr>

</tbody>

</table>

</div>

/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */

var searchBox = new SearchBox("searchBox", "search/",'.html');

/* @license-end */

</script>

/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */

$(function() { codefold.init(0); });

/* @license-end */

</script>

/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */

$(function() {

initMenu('',true,false,'search.php','Search',true);

$(function() { init_search(); });

});

/* @license-end */

</script>

</div>

</div>

<div id="splitbar" style="-moz-user-select:none;"

class="ui-resizable-handle">

</div>

/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */

$(function(){initNavTree('annotated.html',''); initResizable(true); });

/* @license-end */

</script>

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

<div class="SRStatus" id="Loading">Loading...</div>

<div class="SRStatus" id="Searching">Searching...</div>

<div class="SRStatus" id="NoMatches">No Matches</div>

</div>

<div class="headertitle"><div class="title">Class List</div></div>

</div>

<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">

<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span>]</div><table class="directory">

<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacetf.html" target="_self">tf</a></td><td class="desc"><a class="el" href="classtf_1_1Taskflow.html" title="class to create a taskflow object">Taskflow</a> namespace </td></tr>

<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1AsyncTask.html" target="_self">AsyncTask</a></td><td class="desc">Class to hold a dependent asynchronous task with shared ownership </td></tr>

<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1BoundedPriorityWSQ.html" target="_self">BoundedPriorityWSQ</a></td><td class="desc">Class to create a lock-free bounded work-stealing queue with priority support </td></tr>

<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1BoundedWSQ.html" target="_self">BoundedWSQ</a></td><td class="desc">Class to create a lock-free bounded work-stealing queue </td></tr>

<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1CachelineAligned.html" target="_self">CachelineAligned</a></td><td class="desc">Class to ensure cacheline-aligned storage for an object </td></tr>

<tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaEventBase.html" target="_self">cudaEventBase</a></td><td class="desc">Class to create a CUDA event with unique ownership </td></tr>

<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaEventCreator.html" target="_self">cudaEventCreator</a></td><td class="desc">Class to create functors that construct CUDA events </td></tr>

<tr id="row_0_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaEventDeleter.html" target="_self">cudaEventDeleter</a></td><td class="desc">Class to create a functor that deletes a CUDA event </td></tr>

<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphBase.html" target="_self">cudaGraphBase</a></td><td class="desc">Class to create a CUDA graph with uunique ownership </td></tr>

<tr id="row_0_8_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphCreator.html" target="_self">cudaGraphCreator</a></td><td class="desc">Class to create functors that construct CUDA graphs </td></tr>

<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphDeleter.html" target="_self">cudaGraphDeleter</a></td><td class="desc">Class to create a functor that deletes a CUDA graph </td></tr>

<tr id="row_0_10_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphExecBase.html" target="_self">cudaGraphExecBase</a></td><td class="desc">Class to create an executable CUDA graph with unique ownership </td></tr>

<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphExecCreator.html" target="_self">cudaGraphExecCreator</a></td><td class="desc">Class to create functors for constructing executable CUDA graphs </td></tr>

<tr id="row_0_12_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaGraphExecDeleter.html" target="_self">cudaGraphExecDeleter</a></td><td class="desc">Class to create a functor for deleting an executable CUDA graph </td></tr>

<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaScopedDevice.html" target="_self">cudaScopedDevice</a></td><td class="desc">Class to create an RAII-styled context switch </td></tr>

<tr id="row_0_14_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaStreamBase.html" target="_self">cudaStreamBase</a></td><td class="desc">Class to create a CUDA stream with unique ownership </td></tr>

<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaStreamCreator.html" target="_self">cudaStreamCreator</a></td><td class="desc">Class to create functors that construct CUDA streams </td></tr>

<tr id="row_0_16_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaStreamDeleter.html" target="_self">cudaStreamDeleter</a></td><td class="desc">Class to create a functor that deletes a CUDA stream </td></tr>

<tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1cudaTask.html" target="_self">cudaTask</a></td><td class="desc">Class to create a task handle of a CUDA Graph node </td></tr>

<tr id="row_0_18_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1DataPipe.html" target="_self">DataPipe</a></td><td class="desc">Class to create a stage in a data-parallel pipeline </td></tr>

<tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1DataPipeline.html" target="_self">DataPipeline</a></td><td class="desc">Class to create a data-parallel pipeline scheduling framework </td></tr>

<tr id="row_0_20_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1DefaultClosureWrapper.html" target="_self">DefaultClosureWrapper</a></td><td class="desc">Class to create a default closure wrapper </td></tr>

<tr id="row_0_21_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1DefaultTaskParams.html" target="_self">DefaultTaskParams</a></td><td class="desc">Class to create an empty task parameter for compile-time optimization </td></tr>

<tr id="row_0_22_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1DynamicPartitioner.html" target="_self">DynamicPartitioner</a></td><td class="desc">Class to create a dynamic partitioner for scheduling parallel algorithms </td></tr>

<tr id="row_0_23_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Executor.html" target="_self">Executor</a></td><td class="desc">Class to create an executor </td></tr>

<tr id="row_0_24_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1FlowBuilder.html" target="_self">FlowBuilder</a></td><td class="desc">Class to build a task dependency graph </td></tr>

<tr id="row_0_25_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Future.html" target="_self">Future</a></td><td class="desc">Class to access the result of an execution </td></tr>

<tr id="row_0_26_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Graph.html" target="_self">Graph</a></td><td class="desc">Class to create a graph object </td></tr>

<tr id="row_0_27_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1GuidedPartitioner.html" target="_self">GuidedPartitioner</a></td><td class="desc">Class to create a guided partitioner for scheduling parallel algorithms </td></tr>

<tr id="row_0_28_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1IndexRanges.html" target="_self">IndexRanges</a></td><td class="desc">Class to create an N-dimensional index range of integral indices </td></tr>

<tr id="row_0_29_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1NonblockingNotifier.html" target="_self">NonblockingNotifier</a></td><td class="desc">Class to create a non-blocking notifier </td></tr>

<tr id="row_0_30_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1ObjectPool.html" target="_self">ObjectPool</a></td><td class="desc">Sharded fixed-size object allocator with a lock-free hot path </td></tr>

<tr id="row_0_31_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1ObserverInterface.html" target="_self">ObserverInterface</a></td><td class="desc">Class to derive an executor observer </td></tr>

<tr id="row_0_32_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1PartitionerBase.html" target="_self">PartitionerBase</a></td><td class="desc">Class to derive a partitioner for scheduling parallel algorithms </td></tr>

<tr id="row_0_33_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Pipe.html" target="_self">Pipe</a></td><td class="desc">Class to create a pipe object for a pipeline stage </td></tr>

<tr id="row_0_34_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Pipeflow.html" target="_self">Pipeflow</a></td><td class="desc">Class to create a pipeflow object used by the pipe callable </td></tr>

<tr id="row_0_35_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Pipeline.html" target="_self">Pipeline</a></td><td class="desc">Class to create a pipeline scheduling framework </td></tr>

<tr id="row_0_36_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1RandomPartitioner.html" target="_self">RandomPartitioner</a></td><td class="desc">Class to construct a random partitioner for scheduling parallel algorithms </td></tr>

<tr id="row_0_37_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Runtime.html" target="_self">Runtime</a></td><td class="desc">Class to create a runtime task </td></tr>

<tr id="row_0_38_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1ScalablePipeline.html" target="_self">ScalablePipeline</a></td><td class="desc">Class to create a scalable pipeline object </td></tr>

<tr id="row_0_39_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Semaphore.html" target="_self">Semaphore</a></td><td class="desc">Class to create a semophore object for building a concurrency constraint </td></tr>

<tr id="row_0_40_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1SmallVector.html" target="_self">SmallVector</a></td><td class="desc">Class to define a vector optimized for small array </td></tr>

<tr id="row_0_41_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1StaticPartitioner.html" target="_self">StaticPartitioner</a></td><td class="desc">Class to construct a static partitioner for scheduling parallel algorithms </td></tr>

<tr id="row_0_42_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Subflow.html" target="_self">Subflow</a></td><td class="desc">Class to construct a subflow graph from the execution of a dynamic task </td></tr>

<tr id="row_0_43_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtf_1_1TaggedHead128.html" target="_self">TaggedHead128</a></td><td class="desc">Tagged free-list head using a 128-bit (pointer, version) pair </td></tr>

<tr id="row_0_44_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtf_1_1TaggedHead64.html" target="_self">TaggedHead64</a></td><td class="desc">Tagged free-list head packed into a single 64-bit word </td></tr>

<tr id="row_0_45_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Task.html" target="_self">Task</a></td><td class="desc">Class to create a task handle over a taskflow node </td></tr>

<tr id="row_0_46_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Taskflow.html" target="_self">Taskflow</a></td><td class="desc">Class to create a taskflow object </td></tr>

<tr id="row_0_47_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1TaskGroup.html" target="_self">TaskGroup</a></td><td class="desc">Class to create a task group from a task </td></tr>

<tr id="row_0_48_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1TaskParams.html" target="_self">TaskParams</a></td><td class="desc">Class to create a task parameter object </td></tr>

<tr id="row_0_49_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1TaskView.html" target="_self">TaskView</a></td><td class="desc">Class to access task information from the observer interface </td></tr>

<tr id="row_0_50_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1UnboundedWSQ.html" target="_self">UnboundedWSQ</a></td><td class="desc">Class to create a lock-free unbounded work-stealing queue </td></tr>

<tr id="row_0_51_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Worker.html" target="_self">Worker</a></td><td class="desc">Class to create a worker in an executor </td></tr>

<tr id="row_0_52_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1WorkerInterface.html" target="_self">WorkerInterface</a></td><td class="desc">Class to configure worker behavior in an executor </td></tr>

<tr id="row_0_53_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1WorkerView.html" target="_self">WorkerView</a></td><td class="desc">Class to create an immutable view of a worker </td></tr>

<tr id="row_0_54_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtf_1_1Xorshift.html" target="_self">Xorshift</a></td><td class="desc">Class to create a fast xorshift-based pseudo-random number generator </td></tr>

<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structhash.html" target="_self">hash</a></td><td class="desc">Hash specialization for std::hash<tf::Task> </td></tr>

</table>

</div>

</div>

</div>

<ul>

Maintained by <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>

 — 

Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1

</li>

</ul>

</div>

taskflow/docs/annotated.html at master · taskflow/taskflow · GitHub

Uh oh!

Expand file tree

Breadcrumbs

annotated.html

Latest commit

History

Breadcrumbs

annotated.html

File metadata and controls